Class Options

constructor

• new Options(): Options

• Returns Options

Optional packageDir

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
• addDeclaration(declaration): void

• Adds an option declaration to the container.

  Parameters

  • declaration: Readonly<DeclarationOption>

    The option declaration that should be added.

  Returns void

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

copyForPackage

• copyForPackage(packageDir): Options

• Clones the options, intended for use in packages mode.

  Parameters

  • packageDir: string

  Returns Options

fixCompilerOptions

• fixCompilerOptions(options): CompilerOptions
• Internal

  Parameters

  • options: Readonly<CompilerOptions>

  Returns CompilerOptions

freeze

• freeze(): void

• Marks the options as readonly, enables caching when fetching options, which improves performance.

  Returns void

getCompilerOptions

• getCompilerOptions(): CompilerOptions

• Gets the set compiler options.

  Returns CompilerOptions

getDeclaration

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

• Gets a declaration by one of its names.

  Parameters

  • name: string

  Returns undefined | Readonly<DeclarationOption>

getDeclarations

• getDeclarations(): Readonly<DeclarationOption>[]

• Gets all declared options.

  Returns Readonly<DeclarationOption>[]

getFileNames

• getFileNames(): readonly string[]

• Gets the file names discovered through reading a tsconfig file.

  Returns readonly string[]

getHelp

• getHelp(): string

• Get the help message to be displayed to the user if --help is passed.

  Returns string

getProjectReferences

• getProjectReferences(): readonly ProjectReference[]

• Gets the project references - used in solution style tsconfig setups.

  Returns readonly ProjectReference[]

getRawValues

• getRawValues(): Readonly<Partial<TypeDocOptions>>

• Gets all of the TypeDoc option values defined in this option container.

  Returns Readonly<Partial<TypeDocOptions>>

getSimilarOptions

• getSimilarOptions(missingName): string[]

• Discover similar option names to the given name, for use in error reporting.

  Parameters

  • missingName: string

  Returns string[]

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]
• getValue(name): unknown

• Parameters

  • name: string

  Returns unknown

isFrozen

• isFrozen(): boolean

• Checks if the options object has been frozen, preventing future changes to option values.

  Returns boolean

isSet

• isSet(name): boolean

• Checks if the given option's value is deeply strict equal to the default.

  Parameters

  • name: keyof TypeDocOptionMap

  Returns boolean
• isSet(name): boolean

• Parameters

  • name: string

  Returns boolean

read

• read(logger, cwd?): Promise<void>

• Parameters

  • logger: Logger
  • cwd: string = ...

  Returns Promise<void>

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
• reset(name?): void

• Parameters

  • Optional name: string

  Returns void

restore

• restore(snapshot): void
• Internal

  Take a snapshot of option values now, used in tests only.

  Parameters

  • snapshot: {
        __optionSnapshot: never;
    }

    • __optionSnapshot: never

  Returns void

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

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
• setValue(name, value, configPath?): void

• Parameters

  • name: string
  • value: unknown
  • Optional configPath: string

  Returns void

snapshot

• snapshot(): {
      __optionSnapshot: never;
  }
• Internal

  Take a snapshot of option values now, used in tests only.

  Returns {
      __optionSnapshot: never;
  }

  • __optionSnapshot: never