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

Properties

`Optional` packageDir

packageDir?: string

In packages mode, the directory of the package being converted.

Methods

addDeclaration

addDeclaration<K>(declaration): 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:217
addDeclaration(declaration): 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:225

addReader

addReader(reader): 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:202

copyForPackage

copyForPackage(packageDir): Options
Clones the options, intended for use in packages mode.
Parameters
- packageDir: string
Returns Options
- Defined in src/lib/utils/options/options.ts:111

fixCompilerOptions

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

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:126

getCompilerOptions

getCompilerOptions(): CompilerOptions
Gets the set compiler options.

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

getDeclaration

getDeclaration(name): 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:245

getDeclarations

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

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

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:377

getHelp

getHelp(): string
Get the help message to be displayed to the user if --help is passed.

Returns string
- Defined in src/lib/utils/options/options.ts:439

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:384

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:272

getSimilarOptions

getSimilarOptions(missingName): string[]
Discover similar option names to the given name, for use in error reporting.
Parameters
- missingName: string
Returns string[]
- Defined in src/lib/utils/options/options.ts:418

getValue

getValue<K>(name): 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:280
getValue(name): unknown
Parameters
- name: string
Returns unknown
- Defined in src/lib/utils/options/options.ts:281

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:133

isSet

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

read

read(logger, cwd?): void
Parameters
- logger: Logger
- cwd: string = ...
Returns void
- Defined in src/lib/utils/options/options.ts:206

reset

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

restore

restore(snapshot): 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:156

setCompilerOptions

setCompilerOptions(fileNames, options, projectReferences): 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:391

setLogger

setLogger(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:166

setValue

setValue<K>(name, value, configPath?): 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:302
setValue(name, value, configPath?): void
Parameters
- name: string
- value: unknown
- Optional configPath: string
Returns void
- Defined in src/lib/utils/options/options.ts:307

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:141

Class Options

Option Discovery

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

logger: Logger

Returns Options

Properties

Optional packageDir

Methods

addDeclaration

Type Parameters

K extends keyof TypeDocOptionMap

Parameters

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

Returns void

Parameters

declaration: Readonly<DeclarationOption>

Returns void

addReader

Parameters

reader: OptionsReader

Returns void

copyForPackage

Parameters

packageDir: string

Returns Options

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[]

getHelp

Returns string

getProjectReferences

Returns readonly ProjectReference[]

getRawValues

Returns Readonly<Partial<TypeDocOptions>>

getSimilarOptions

Parameters

missingName: string

Returns string[]

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

cwd: string = ...

`Optional` packageDir

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

`Optional` name: keyof TypeDocOptionMap

`Optional` name: string

snapshot: {
__optionSnapshot: never;
}

`Optional` configPath: string

`Optional` configPath: string

Returns {
__optionSnapshot: never;
}