Properties
categorizeByGroup
categorizeByGroup: boolean
categoryOrder
categoryOrder: string[]
cleanOutputDir
cleanOutputDir: boolean
customCss
customCss: string
darkHighlightTheme
darkHighlightTheme: Theme
defaultCategory
defaultCategory: string
disableSources
disableSources: boolean
emit
emit: { both: "both"; docs: "docs"; false: false; none: "none"; true: true }
Type declaration
both: "both"
docs: "docs"
false: false
none: "none"
true: true
entryPointStrategy
entryPointStrategy: { Expand: "expand"; Packages: "packages"; Resolve: "resolve" }
Type declaration
Expand: "expand"
Packages: "packages"
Resolve: "resolve"
entryPoints
entryPoints: string[]
excludeExternals
excludeExternals: boolean
excludeInternal
excludeInternal: boolean
excludeNotDocumented
excludeNotDocumented: boolean
excludePrivate
excludePrivate: boolean
excludeProtected
excludeProtected: boolean
excludeTags
excludeTags: string[]
externalPattern
externalPattern: string[]
gitRemote
gitRemote: string
gitRevision
gitRevision: string
githubPages
githubPages: boolean
hideGenerator
hideGenerator: boolean
hideLegend
hideLegend: boolean
includeVersion
includeVersion: boolean
intentionallyNotExported
intentionallyNotExported: string[]
lightHighlightTheme
lightHighlightTheme: Theme
listInvalidSymbolLinks
listInvalidSymbolLinks: boolean
markedOptions
markedOptions: unknown
preserveWatchOutput
preserveWatchOutput: boolean
showConfig
showConfig: boolean
sort
sort: ("source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "static-first" | "instance-first" | "visibility" | "required-first" | "kind")[]
treatWarningsAsErrors
treatWarningsAsErrors: boolean
Describes all TypeDoc options. Used internally to provide better types when fetching options. External consumers should likely use TypeDocOptions instead.