Interface OptionsReader

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


  • OptionsReader

Implemented by




name: string

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

Readers will be processed according to their priority. A higher priority indicates that the reader should be called later so that it can override options set by lower priority readers.

Note that to preserve expected behavior, the argv reader must have both the lowest priority so that it may set the location of config files used by other readers and the highest priority so that it can override settings from lower priority readers.

Note: In 0.23. priority will be renamed to order, with the same meaning


  • 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.


    • container: Options

      the options container that provides declarations

    • logger: Logger

    Returns void

Generated using TypeDoc