Class TSConfigReader

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

Hierarchy

  • TSConfigReader

Implements

Constructors

Properties

Methods

Constructors

Properties

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.

priority: number = 200

Note: Runs after the TypeDocReader.

Methods

  • 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 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 setValue, which will correctly convert values.

    Parameters

    • container: Options

      the options container that provides declarations

    • logger: Logger

    Returns void

  • Internal

    Not considered part of the public API. You can use it, but it might break.

    Parameters

    • file: string

    Returns undefined | string

Generated using TypeDoc