Logo for jsDocs.io

typedoc

  • Version 0.28.20
  • Published
  • 2.18 MB
  • 5 dependencies
  • Apache-2.0 license

Install

npm i typedoc
yarn add typedoc
pnpm add typedoc

Overview

Create api documentation for TypeScript projects.

Index

Classes

Classes

class TypeDocReader

class TypeDocReader implements OptionsReader {}

  • Obtains option values from typedoc.json

property name

name: string;

    property order

    order: number;

    • Should run before the tsconfig reader so that it can specify a tsconfig file to read.

    property supportsPackages

    supportsPackages: boolean;

      method read

      read: (
          container: Options,
          logger: Logger,
          cwd: string,
          usedFile: (path: string) => void
      ) => Promise<void>;

      • Read user configuration from a typedoc.json or typedoc.js configuration file.

      Package Files (1)

      Dependencies (5)

      Dev Dependencies (16)

      Peer Dependencies (1)

      Badge

      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/typedoc.

      • Markdown
        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/typedoc)
      • HTML
        <a href="https://www.jsdocs.io/package/typedoc"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>