Class Options

constructor

• new Options(): Options

  Returns Options

OptionalpackageDir

addDeclaration

• addDeclaration<K extends keyof TypeDocOptionMap>(
      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

• 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

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

copyForPackage

• copyForPackage(packageDir: string): Options

  Clones the options, intended for use in packages mode.

  Parameters

  • packageDir: string

  Returns Options

getCompilerOptions

• getCompilerOptions(logger: Logger): CompilerOptions

  Gets the set compiler options.

  Parameters

  • logger: Logger

  Returns CompilerOptions

getDeclaration

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

  Gets a declaration by one of its names.

  Parameters

  • name: string

  Returns Readonly<DeclarationOption> | undefined

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

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

  Returns Readonly<Partial<TypeDocOptionValues>>

getSimilarOptions

• getSimilarOptions(missingName: string): string[]

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

  Parameters

  • missingName: string

  Returns string[]

getValue

• getValue<K extends keyof TypeDocOptionMap>(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]

• getValue(name: string): unknown

  Gets a value for the given option key, throwing if the option has not been declared.

  Parameters

  • name: string

  Returns unknown

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

• isSet(name: string): boolean

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

  Parameters

  • name: string

  Returns boolean

read

• read(
      logger: Logger,
      cwd?: string,
      usedFile?: (path: string) => void,
  ): Promise<void>

  Parameters

  • logger: Logger
  • Optionalcwd: string
  • OptionalusedFile: (path: string) => void

  Returns Promise<void>

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

  • Optionalname: keyof TypeDocOptionMap

  Returns void

• reset(name?: string): void

  Resets the option bag to all default values. If a name is provided, will only reset that name.

  Parameters

  • Optionalname: string

  Returns void

setCompilerOptions

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

  Sets the compiler options that will be used to get a TS program.

  Parameters

  • fileNames: readonly string[]
  • options: CompilerOptions
  • projectReferences: readonly ProjectReference[] | undefined

  Returns void

setValue

• setValue<K extends keyof TypeDocOptionMap>(
      name: K,
      value: Exclude<TypeDocOptions[K], undefined>,
      configPath?: string,
  ): void

  Sets the given declared option. Throws if setting the option fails.

  Type Parameters

  • K extends keyof TypeDocOptionMap

  Parameters

  • name: K
  • value: Exclude<TypeDocOptions[K], undefined>
  • OptionalconfigPath: string

    the directory to resolve Path type values against

  Returns void

• setValue(name: string, value: unknown, configPath?: string): void

  Sets the given declared option. Throws if setting the option fails.

  Parameters

  • name: string
  • value: unknown
  • OptionalconfigPath: string

    the directory to resolve Path type values against

  Returns void