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 blockTags categorizeByGroup categoryOrder cleanOutputDir cname commentStyle compilerOptions customCss darkHighlightTheme defaultCategory disableSources emit entryPointStrategy entryPoints exclude excludeExternals excludeInternal excludeNotDocumented excludePrivate excludeProtected excludeTags externalPattern externalSymbolLinkMappings gaID gitRemote gitRevision githubPages help hideGenerator htmlLang includeVersion includes inlineTags intentionallyNotExported json kindSortOrder lightHighlightTheme logLevel logger markedOptions media modifierTags name navigationLinks options out plugin preserveWatchOutput pretty readme requiredToBeDocumented searchCategoryBoosts searchGroupBoosts searchInComments showConfig sidebarLinks skipErrorChecking sort sourceLinkTemplate theme titleLink treatWarningsAsErrors tsconfig validation version visibilityFilters watch

Properties

basePath

basePath: string

blockTags

blockTags: `@${string}`[]

categorizeByGroup

categorizeByGroup: boolean

categoryOrder

categoryOrder: string[]

cleanOutputDir

cleanOutputDir: boolean

cname

cname: string

commentStyle

commentStyle: {
    All: "all";
    Block: "block";
    JSDoc: "jsdoc";
    Line: "line";
}

Type declaration

  • All: "all"
  • Block: "block"
  • JSDoc: "jsdoc"
  • Line: "line"

compilerOptions

compilerOptions: unknown

customCss

customCss: string

darkHighlightTheme

darkHighlightTheme: Theme

defaultCategory

defaultCategory: string

disableSources

disableSources: boolean

emit

emit: {
    both: "both";
    docs: "docs";
    none: "none";
}

Type declaration

  • both: "both"
  • docs: "docs"
  • none: "none"

entryPointStrategy

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

entryPoints: string[]

exclude

exclude: string[]

excludeExternals

excludeExternals: boolean

excludeInternal

excludeInternal: boolean

excludeNotDocumented

excludeNotDocumented: boolean

excludePrivate

excludePrivate: boolean

excludeProtected

excludeProtected: boolean

excludeTags

excludeTags: `@${string}`[]

externalPattern

externalPattern: string[]

externalSymbolLinkMappings

externalSymbolLinkMappings: ManuallyValidatedOption<Record<string, Record<string, string>>>

gaID

gaID: string

gitRemote

gitRemote: string

gitRevision

gitRevision: string

githubPages

githubPages: boolean

help

help: boolean

hideGenerator

hideGenerator: boolean

htmlLang

htmlLang: string

includeVersion

includeVersion: boolean

includes

includes: string

inlineTags

inlineTags: `@${string}`[]

intentionallyNotExported

intentionallyNotExported: string[]

json

json: string

kindSortOrder

kindSortOrder: ("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")[]

lightHighlightTheme

lightHighlightTheme: Theme

logLevel

logLevel: typeof LogLevel

logger

logger: unknown

markedOptions

markedOptions: unknown

media

media: string

modifierTags

modifierTags: `@${string}`[]

name

name: string

navigationLinks

navigationLinks: ManuallyValidatedOption<Record<string, string>>

options

options: string

out

out: string

plugin

plugin: string[]

preserveWatchOutput

preserveWatchOutput: boolean

pretty

pretty: boolean

readme

readme: string

requiredToBeDocumented

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

searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>

searchGroupBoosts

searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>

searchInComments

searchInComments: boolean

showConfig

showConfig: boolean

sidebarLinks

sidebarLinks: ManuallyValidatedOption<Record<string, string>>

skipErrorChecking

skipErrorChecking: boolean

sort

sort: ("kind" | "source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "static-first" | "instance-first" | "visibility" | "required-first")[]

sourceLinkTemplate

sourceLinkTemplate: string

theme

theme: string

titleLink

titleLink: string

treatWarningsAsErrors

treatWarningsAsErrors: boolean

tsconfig

tsconfig: string

validation

validation: ValidationOptions

version

version: boolean

visibilityFilters

visibilityFilters: ManuallyValidatedOption<{
    external?: boolean;
    inherited?: boolean;
    private?: boolean;
    protected?: boolean;
    [tag: `@${string}`]: boolean;
}>

watch

watch: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc