Properties
categorizeByGroup
categorizeByGroup: boolean
categoryOrder
categoryOrder: string[]
defaultCategory
defaultCategory: string
disableOutputCheck
disableOutputCheck: boolean
disableSources
disableSources: boolean
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[]
gitRemote
gitRemote: string
gitRevision
gitRevision: string
hideGenerator
hideGenerator: boolean
highlightTheme
highlightTheme: Theme
includeVersion
includeVersion: boolean
includes
includes: string
listInvalidSymbolLinks
listInvalidSymbolLinks: boolean
logLevel
logLevel: typeof LogLevel
markedOptions
markedOptions: unknown
packages
packages: string[]
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
tsconfig
tsconfig: string
Describes all TypeDoc options. Used internally to provide better types when fetching options. External consumers should likely use TypeDocOptions instead.