Class Options

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
Parameters
- logger: Logger
Returns Options
- Defined in src/lib/utils/options/options.ts:95

Methods

addDeclaration

addDeclaration<K>(declaration: {
name: K;
} & KeyToDeclaration<K>): void
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 extends 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:200
addDeclaration(declaration: Readonly<DeclarationOption>): void
Adds an option declaration to the container.
Parameters
- declaration: Readonly<DeclarationOption>
  
  The option declaration that should be added.
Returns void
- Defined in src/lib/utils/options/options.ts:208

addDefaultDeclarations

addDefaultDeclarations(): void
Adds the option declarations declared by the TypeDoc and all supported TypeScript declarations.

Returns void
- Defined in src/lib/utils/options/options.ts:149

addReader

addReader(reader: OptionsReader): void
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
- Defined in src/lib/utils/options/options.ts:185

fixCompilerOptions

fixCompilerOptions(options: Readonly<CompilerOptions>): CompilerOptions
Internal
Parameters
- options: Readonly<CompilerOptions>
Returns CompilerOptions
- Defined in src/lib/utils/options/options.ts:331

freeze

freeze(): void
Marks the options as readonly, enables caching when fetching options, which improves performance.

Returns void
- Defined in src/lib/utils/options/options.ts:102

getCompilerOptions

getCompilerOptions(): CompilerOptions
Gets the set compiler options.

Returns CompilerOptions
- Defined in src/lib/utils/options/options.ts:326

getDeclaration

getDeclaration(name: string): undefined | Readonly<DeclarationOption>
Gets a declaration by one of its names.
Parameters
- name: string
Returns undefined | Readonly<DeclarationOption>
- Defined in src/lib/utils/options/options.ts:228

getDeclarations

getDeclarations(): Readonly<DeclarationOption>[]
Gets all declared options.

Returns Readonly<DeclarationOption>[]
- Defined in src/lib/utils/options/options.ts:235

getFileNames

getFileNames(): readonly string[]
Gets the file names discovered through reading a tsconfig file.

Returns readonly string[]
- Defined in src/lib/utils/options/options.ts:352

getProjectReferences

getProjectReferences(): readonly ProjectReference[]
Gets the project references - used in solution style tsconfig setups.

Returns readonly ProjectReference[]
- Defined in src/lib/utils/options/options.ts:359

getRawValues

getRawValues(): Readonly<Partial<TypeDocOptions>>
Gets all of the TypeDoc option values defined in this option container.

Returns Readonly<Partial<TypeDocOptions>>
- Defined in src/lib/utils/options/options.ts:255

getValue

getValue<K>(name: K): TypeDocOptionValues[K]
Gets a value for the given option key, throwing if the option has not been declared.
Type Parameters
- K extends keyof TypeDocOptionMap
Parameters
- name: K
Returns TypeDocOptionValues[K]
- Defined in src/lib/utils/options/options.ts:263
getValue(name: string): unknown
Parameters
- name: string
Returns unknown
- Defined in src/lib/utils/options/options.ts:264

isFrozen

isFrozen(): boolean
Checks if the options object has been frozen, preventing future changes to option values.

Returns boolean
- Defined in src/lib/utils/options/options.ts:109

isSet

isSet(name: keyof TypeDocOptionMap): boolean
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:243
isSet(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/lib/utils/options/options.ts:244

read

read(logger: Logger): void
Parameters
- logger: Logger
Returns void
- Defined in src/lib/utils/options/options.ts:189

reset

reset(name?: keyof TypeDocOptionMap): void
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:157
reset(name?: string): void
Parameters
- Optional name: string
Returns void
- Defined in src/lib/utils/options/options.ts:158

restore

restore(snapshot: {
__optionSnapshot: never;
}): void
Internal
Take a snapshot of option values now, used in tests only.
Parameters
- snapshot: {
  __optionSnapshot: never;
  }
  - __optionSnapshot: never
Returns void
- Defined in src/lib/utils/options/options.ts:132

setCompilerOptions

setCompilerOptions(fileNames: readonly string[], options: CompilerOptions, projectReferences: undefined | readonly ProjectReference[]): void
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
- Defined in src/lib/utils/options/options.ts:366

setLogger

setLogger(logger: Logger): void
Sets the logger used when an option declaration fails to be added.
Parameters
- logger: Logger
Returns void
- Defined in src/lib/utils/options/options.ts:142

setValue

setValue<K>(name: K, value: TypeDocOptions[K], configPath?: string): void
Sets the given declared option. Throws if setting the option fails.
Type Parameters
- K extends 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:280
setValue(name: string, value: unknown, configPath?: string): void
Parameters
- name: string
- value: unknown
- Optional configPath: string
Returns void
- Defined in src/lib/utils/options/options.ts:285

snapshot

snapshot(): {
__optionSnapshot: never;
}
Internal
Take a snapshot of option values now, used in tests only.

Returns {
__optionSnapshot: never;
}
- __optionSnapshot: never
- Defined in src/lib/utils/options/options.ts:117

Class Options

Option Discovery

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

logger: Logger

Returns Options

Methods

addDeclaration

Type Parameters

K extends keyof TypeDocOptionMap

Parameters

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

Returns void

Parameters

declaration: Readonly<DeclarationOption>

Returns void

addDefaultDeclarations

Returns void

addReader

Parameters

reader: OptionsReader

Returns void

fixCompilerOptions

Parameters

options: Readonly<CompilerOptions>

Returns CompilerOptions

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 extends 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

reset

Parameters

Optional name: keyof TypeDocOptionMap

Returns void

Parameters

Optional name: string

Returns void

restore

Parameters

snapshot: { __optionSnapshot: never; }

__optionSnapshot: never

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

`Optional` name: keyof TypeDocOptionMap

`Optional` name: string

snapshot: {
__optionSnapshot: never;
}

`Optional` configPath: string

`Optional` configPath: string

Returns {
__optionSnapshot: never;
}