Options | TypeDoc Documentation

Maintains a collection of option declarations split into TypeDoc options and TypeScript options. Ensures options are of the correct type for calling code.

Option Discovery

Since plugins commonly add custom options, and TypeDoc does not permit options which have not been declared to be set, options must be read twice. The first time options are read, a noop logger is passed so that any errors are ignored. Then, after loading plugins, options are read again, this time with the logger specified by the application.

Options are read in a specific order.

argv (0) - Must be read first since it should change the files read when passing --options or --tsconfig.
typedoc-json (100) - Read next so that it can specify the tsconfig.json file to read.
tsconfig-json (200) - Last config file reader, cannot specify the typedoc.json file to read.
argv (300) - Read argv again since any options set there should override those set in config files.

Hierarchy

Options

Constructors

constructor

new Options(logger: Logger): Options

- Defined in src/lib/utils/options/options.ts:85
Parameters
- logger: Logger
Returns Options

Methods

addDeclaration

addDeclaration<K>(declaration: { name: K } & KeyToDeclaration<K>): void
addDeclaration(declaration: Readonly<DeclarationOption>): void

- Defined in src/lib/utils/options/options.ts:174
Adds an option declaration to the container with extra type checking to ensure that the runtime type is consistent with the declared type.

Type parameters
- K: keyof TypeDocOptionMap
Parameters
- declaration: { name: K } & KeyToDeclaration<K>
  
  The option declaration that should be added.
Returns void
- Defined in src/lib/utils/options/options.ts:182
Adds an option declaration to the container.

Parameters
- declaration: Readonly<DeclarationOption>
  
  The option declaration that should be added.
Returns void

addDeclarations

addDeclarations(declarations: readonly DeclarationOption[]): void

- Defined in src/lib/utils/options/options.ts:203
Adds the given declarations to the container

deprecated
will be removed in 0.23.

Parameters
- declarations: readonly DeclarationOption[]
Returns void

addDefaultDeclarations

addDefaultDeclarations(): void

- Defined in src/lib/utils/options/options.ts:114
Adds the option declarations declared by the TypeDoc and all supported TypeScript declarations.

Returns void

addReader

addReader(reader: OptionsReader): void

- Defined in src/lib/utils/options/options.ts:150
Adds an option reader that will be used to read configuration values from the command line, configuration files, or other locations.

Parameters
- reader: OptionsReader
Returns void

freeze

freeze(): void

- Defined in src/lib/utils/options/options.ts:92
Marks the options as readonly, enables caching when fetching options, which improves performance.

Returns void

getCompilerOptions

getCompilerOptions(): CompilerOptions

- Defined in src/lib/utils/options/options.ts:321
Gets the set compiler options.

Returns CompilerOptions

getDeclaration

getDeclaration(name: string): undefined | Readonly<DeclarationOption>

- Defined in src/lib/utils/options/options.ts:228
Gets a declaration by one of its names.

Parameters
- name: string
Returns undefined | Readonly<DeclarationOption>

getDeclarations

getDeclarations(): Readonly<DeclarationOption>[]

- Defined in src/lib/utils/options/options.ts:235
Gets all declared options.

Returns Readonly<DeclarationOption>[]

getFileNames

getFileNames(): readonly string[]

- Defined in src/lib/utils/options/options.ts:345
Gets the file names discovered through reading a tsconfig file.

Returns readonly string[]

getProjectReferences

getProjectReferences(): readonly ProjectReference[]

- Defined in src/lib/utils/options/options.ts:352
Gets the project references - used in solution style tsconfig setups.

Returns readonly ProjectReference[]

getRawValues

getRawValues(): Readonly<Partial<TypeDocOptions>>

- Defined in src/lib/utils/options/options.ts:255
Gets all of the TypeDoc option values defined in this option container.

Returns Readonly<Partial<TypeDocOptions>>

getValue

getValue<K>(name: K): TypeDocOptionValues[K]
getValue(name: string): unknown

- Defined in src/lib/utils/options/options.ts:263
Gets a value for the given option key, throwing if the option has not been declared.

Type parameters
- K: keyof TypeDocOptionMap
Parameters
- name: K
Returns TypeDocOptionValues[K]
- Defined in src/lib/utils/options/options.ts:264
Parameters
- name: string
Returns unknown

isFrozen

isFrozen(): boolean

- Defined in src/lib/utils/options/options.ts:99
Checks if the options object has been frozen, preventing future changes to option values.

Returns boolean

isSet

isSet(name: keyof TypeDocOptionMap): boolean
isSet(name: string): boolean

- Defined in src/lib/utils/options/options.ts:243
Checks if the given option's value is deeply strict equal to the default.

Parameters
- name: keyof TypeDocOptionMap
Returns boolean
- Defined in src/lib/utils/options/options.ts:244
Parameters
- name: string
Returns boolean

read

read(logger: Logger): void

- Defined in src/lib/utils/options/options.ts:163
Parameters
- logger: Logger
Returns void

removeDeclarationByName

removeDeclarationByName(name: string): void

- Defined in src/lib/utils/options/options.ts:216
Removes a declared option. WARNING: This is probably a bad idea. If you do this you will probably cause a crash when code assumes that an option that it declared still exists.

deprecated
will be removed in 0.23.

Parameters
- name: string
Returns void

removeReaderByName

removeReaderByName(name: string): void

- Defined in src/lib/utils/options/options.ts:159
Removes all readers of a given name.

deprecated
should not be used, will be removed in 0.23

Parameters
- name: string
Returns void

reset

reset(name?: keyof TypeDocOptionMap): void
reset(name?: string): void

- Defined in src/lib/utils/options/options.ts:122
Resets the option bag to all default values. If a name is provided, will only reset that name.

Parameters
- Optional name: keyof TypeDocOptionMap
Returns void
- Defined in src/lib/utils/options/options.ts:123
Parameters
- Optional name: string
Returns void

setCompilerOptions

setCompilerOptions(fileNames: readonly string[], options: CompilerOptions, projectReferences: undefined | readonly ProjectReference[]): void

- Defined in src/lib/utils/options/options.ts:359
Sets the compiler options that will be used to get a TS program.

Parameters
- fileNames: readonly string[]
- options: CompilerOptions
- projectReferences: undefined | readonly ProjectReference[]
Returns void

setLogger

setLogger(logger: Logger): void

- Defined in src/lib/utils/options/options.ts:107
Sets the logger used when an option declaration fails to be added.

Parameters
- logger: Logger
Returns void

setValue

setValue<K>(name: K, value: TypeDocOptions[K], configPath?: string): void
setValue(name: string, value: unknown, configPath?: string): void

- Defined in src/lib/utils/options/options.ts:280
Sets the given declared option. Throws if setting the option fails.

Type parameters
- K: keyof TypeDocOptionMap
Parameters
- name: K
- value: TypeDocOptions[K]
- Optional configPath: string
  
  the directory to resolve Path type values against
Returns void
- Defined in src/lib/utils/options/options.ts:285
Parameters
- name: string
- value: unknown
- Optional configPath: string
Returns void

Option Discovery

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

logger: Logger

Returns Options

Methods

addDeclaration

Type parameters

K: keyof TypeDocOptionMap

Parameters

declaration: { name: K } & KeyToDeclaration<K>

Returns void

Parameters

declaration: Readonly<DeclarationOption>

Returns void

addDeclarations

Parameters

declarations: readonly DeclarationOption[]

Returns void

addDefaultDeclarations

Returns void

addReader

Parameters

reader: OptionsReader

Returns void

freeze

Returns void

getCompilerOptions

Returns CompilerOptions

getDeclaration

Parameters

name: string

Returns undefined | Readonly<DeclarationOption>

getDeclarations

Returns Readonly<DeclarationOption>[]

getFileNames

Returns readonly string[]

getProjectReferences

Returns readonly ProjectReference[]

getRawValues

Returns Readonly<Partial<TypeDocOptions>>

getValue

Type parameters

K: keyof TypeDocOptionMap

Parameters

name: K

Returns TypeDocOptionValues[K]

Parameters

name: string

Returns unknown

isFrozen

Returns boolean

isSet

Parameters

name: keyof TypeDocOptionMap

Returns boolean

Parameters

name: string

Returns boolean

read

Parameters

logger: Logger

Returns void

removeDeclarationByName

Parameters

name: string

Returns void

removeReaderByName

Parameters

name: string

Returns void

reset

Parameters

Optional name: keyof TypeDocOptionMap

Returns void