Class OptionManager

Helper class for retrieving and validating plugin options

Hierarchy

OptionManager

Index

Constructors

constructor

Properties

_validator

Methods

Constructors

constructor

new OptionManager(validator: OptionValidator): OptionManager

- Defined in src/options/option-manager.ts:17
Parameters
- validator: OptionValidator
Returns OptionManager

Properties

Private _validator

_validator: OptionValidator

Methods

Private _readPluginOptions

_readPluginOptions(typeDocOptions: Options): PluginOptions

- Defined in src/options/option-manager.ts:31
Parameters
- typeDocOptions: Options
Returns PluginOptions

Private _tryReadOptionsFromFile

_tryReadOptionsFromFile(path: string): any

- Defined in src/options/option-manager.ts:53
Parameters
- path: string
Returns any

getPluginOptions

getPluginOptions(typeDocOptions: Options): PluginOptions

- Defined in src/options/option-manager.ts:23
Parameters
- typeDocOptions: Options
Returns PluginOptions

Generated using TypeDoc