Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • TSConfigReader

Implements

Index

Constructors

Properties

Methods

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.

priority

priority: number = 200

Note: Runs after the TypeDocReader.

Methods

read

  • read(container: Options, logger: Logger): 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
    • logger: Logger

    Returns void

Generated using TypeDoc