Class TSConfigReader

Describes an option reader that discovers user configuration and converts it to the TypeDoc format.

Implements

Constructors

constructor

Properties

name order supportsPackages

Methods

read

Constructors

constructor

Properties

name

name: string = "tsconfig-json"

The name of this reader so that it may be removed by plugins without the plugin accessing the instance performing the read. Multiple readers may have the same name.

order

order: number = 200

Note: Runs after the TypeDocReader.

supportsPackages

supportsPackages: boolean = true

Flag to indicate that this reader should be included in sub-options objects created to read options for packages mode.

Methods

read

  • read(container, logger, cwd): void

  • Read options from the reader's source and place them in the options parameter. Options without a declared name may be treated as if they were declared with type ParameterType.Mixed. Options which have been declared must be converted to the correct type. As an alternative to doing this conversion in the reader, the reader may use Options.setValue, which will correctly convert values.

    Parameters

    • container: Options

      the options container that provides declarations

    • logger: Logger

      logger to be used to report errors

    • cwd: string

      the directory which should be treated as the current working directory for option file discovery

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods