Optional
alwaysCreateEntryPointModule
alwaysCreateEntryPointModule?: boolean
Optional
basePath
basePath?: string
blockTags?: `@${string}`[]
cascadedModifierTags?: `@${string}`[]
Optional
categorizeByGroup
categorizeByGroup?: boolean
Optional
categoryOrder
categoryOrder?: string[]
commentStyle?:
| "jsdoc"
| "block"
| "line"
| "all"
| "All"
| "JSDoc"
| "Block"
| "Line"
Optional
compilerOptions
compilerOptions?: unknown
Optional
defaultCategory
defaultCategory?: string
Optional
disableGit
disableGit?: boolean
Optional
disableSources
disableSources?: boolean
Optional
emit
emit?: "none" | "both" | "docs"
Optional
entryPoints
entryPoints?: string[]
Optional
entryPointStrategy
entryPointStrategy?:
| "Expand"
| "expand"
| "resolve"
| "packages"
| "merge"
| "Resolve"
| "Packages"
| "Merge"
Optional
exclude
exclude?: string[]
Optional
excludeCategories
excludeCategories?: string[]
Optional
excludeExternals
excludeExternals?: boolean
Optional
excludeInternal
excludeInternal?: boolean
Optional
excludeNotDocumented
excludeNotDocumented?: boolean
Optional
excludeNotDocumentedKinds
Optional
excludePrivate
excludePrivate?: boolean
Optional
excludeProtected
excludeProtected?: boolean
Optional
excludeReferences
excludeReferences?: boolean
excludeTags?: `@${string}`[]
Optional
externalPattern
externalPattern?: string[]
Optional
externalSymbolLinkMappings
externalSymbolLinkMappings?: Record<string, Record<string, string>>
Optional
gitRemote
gitRemote?: string
Optional
gitRevision
gitRevision?: string
Optional
groupOrder
groupOrder?: string[]
Optional
groupReferencesByType
groupReferencesByType?: boolean
Optional
includeVersion
includeVersion?: boolean
inlineTags?: `@${string}`[]
Optional
intentionallyNotDocumented
intentionallyNotDocumented?: string[]
Optional
intentionallyNotExported
intentionallyNotExported?: string[]
Optional
jsDocCompatibility
Optional
maxTypeConversionDepth
maxTypeConversionDepth?: number
modifierTags?: `@${string}`[]
Optional
name
name?: string
Optional
options
options?: string
Optional
packagesRequiringDocumentation
packagesRequiringDocumentation?: string[]
Optional
preserveLinkText
preserveLinkText?: boolean
Optional
projectDocuments
projectDocuments?: string[]
Optional
readme
readme?: string
Optional
requiredToBeDocumented
Optional
skipErrorChecking
skipErrorChecking?: boolean
Optional
sort
sort?: (
| "kind"
| "source-order"
| "alphabetical"
| "alphabetical-ignoring-documents"
| "enum-value-ascending"
| "enum-value-descending"
| "enum-member-source-order"
| "static-first"
| "instance-first"
| "visibility"
| "required-first"
| "external-last"
| "documents-first"
| "documents-last"
)[]
Optional
sortEntryPoints
sortEntryPoints?: boolean
Optional
sourceLinkTemplate
sourceLinkTemplate?: string
suppressCommentWarningsInDeclarationFiles?: boolean
Optional
tsconfig
tsconfig?: string
Optional
useTsLinkResolution
useTsLinkResolution?: boolean
Describes TypeDoc options suitable for setting within the
packageOptions
setting.This is a subset of all options specified in TypeDocOptions.