Interface TypeDocOptionMap

Describes all TypeDoc options. Used internally to provide better types when fetching options. External consumers should likely use TypeDocOptions instead.

Hierarchy

  • TypeDocOptionMap

Properties

basePath: string
blockTags: `@${string}`[]
categorizeByGroup: boolean
categoryOrder: string[]
cleanOutputDir: boolean
cname: string
commentStyle: { All: "all"; Block: "block"; JSDoc: "jsdoc"; Line: "line" }

Type declaration

  • All: "all"
  • Block: "block"
  • JSDoc: "jsdoc"
  • Line: "line"
compilerOptions: unknown
customCss: string
darkHighlightTheme: Theme
defaultCategory: string
disableSources: boolean
emit: { both: "both"; docs: "docs"; none: "none" }

Type declaration

  • both: "both"
  • docs: "docs"
  • none: "none"
entryPointStrategy: { Expand: "expand"; Packages: "packages"; Resolve: "resolve" }

Type declaration

  • Expand: "expand"

    The default behavior in v0.21 and earlier. Behaves like the resolve behavior, but will recursively expand directories into an entry point for each file within the directory.

  • Packages: "packages"

    Alternative resolution mode useful for monorepos. With this mode, TypeDoc will look for a package.json and tsconfig.json under each provided entry point. The main field of each package will be documented.

  • Resolve: "resolve"

    The default behavior in v0.22+, expects all provided entry points as being part of a single program. Any directories included in the entry point list will result in dir/index.([cm][tj]s|[tj]sx?) being used.

entryPoints: string[]
exclude: string[]
excludeExternals: boolean
excludeInternal: boolean
excludeNotDocumented: boolean
excludePrivate: boolean
excludeProtected: boolean
excludeTags: `@${string}`[]
externalPattern: string[]
externalSymbolLinkMappings: ManuallyValidatedOption<Record<string, Record<string, string>>>
gaID: string
gitRemote: string
gitRevision: string
githubPages: boolean
help: boolean
hideGenerator: boolean
htmlLang: string
includeVersion: boolean
includes: string
inlineTags: `@${string}`[]
intentionallyNotExported: string[]
json: string
lightHighlightTheme: Theme
logLevel: typeof LogLevel
logger: unknown
markedOptions: unknown
media: string
modifierTags: `@${string}`[]
name: string
options: string
out: string
plugin: string[]
preserveWatchOutput: boolean
pretty: boolean
readme: string
requiredToBeDocumented: ("Function" | "Project" | "Module" | "Namespace" | "Enum" | "EnumMember" | "Variable" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "Parameter" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "Reference" | "All" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer")[]
searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>
searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>
searchInComments: boolean
showConfig: boolean
skipErrorChecking: boolean
sort: ("kind" | "source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "static-first" | "instance-first" | "visibility" | "required-first")[]
theme: string
treatWarningsAsErrors: boolean
tsconfig: string
validation: ValidationOptions
version: boolean
visibilityFilters: ManuallyValidatedOption<{ external?: boolean; inherited?: boolean; private?: boolean; protected?: boolean; [tag: `@${string}`]: boolean }>
watch: boolean

Generated using TypeDoc