OptionalalwaysCreateEntryPointModule
alwaysCreateEntryPointModule?: boolean
OptionalbasePath
basePath?: string
blockTags?: `@${string}`[]
cascadedModifierTags?: `@${string}`[]
OptionalcategorizeByGroup
categorizeByGroup?: boolean
OptionalcategoryOrder
categoryOrder?: string[]
commentStyle?:
| "jsdoc"
| "block"
| "line"
| "all"
| "All"
| "JSDoc"
| "Block"
| "Line"
OptionalcompilerOptions
compilerOptions?: unknown
OptionaldefaultCategory
defaultCategory?: string
OptionaldisableGit
disableGit?: boolean
OptionaldisableSources
disableSources?: boolean
OptionaldisplayBasePath
displayBasePath?: string
Optionalemit
emit?: "none" | "both" | "docs"
OptionalentryPoints
entryPoints?: string[]
OptionalentryPointStrategy
entryPointStrategy?:
| "Expand"
| "expand"
| "resolve"
| "packages"
| "merge"
| "Resolve"
| "Packages"
| "Merge"
Optionalexclude
exclude?: string[]
OptionalexcludeCategories
excludeCategories?: string[]
OptionalexcludeExternals
excludeExternals?: boolean
OptionalexcludeInternal
excludeInternal?: boolean
OptionalexcludeNotDocumented
excludeNotDocumented?: boolean
OptionalexcludeNotDocumentedKinds
OptionalexcludePrivate
excludePrivate?: boolean
OptionalexcludePrivateClassFields
excludePrivateClassFields?: boolean
OptionalexcludeProtected
excludeProtected?: boolean
OptionalexcludeReferences
excludeReferences?: boolean
excludeTags?: `@${string}`[]
OptionalexternalPattern
externalPattern?: string[]
OptionalexternalSymbolLinkMappings
externalSymbolLinkMappings?: Record<string, Record<string, string>>
OptionalgitRemote
gitRemote?: string
OptionalgitRevision
gitRevision?: string
OptionalgroupOrder
groupOrder?: string[]
OptionalgroupReferencesByType
groupReferencesByType?: boolean
OptionalincludeVersion
includeVersion?: boolean
inlineTags?: `@${string}`[]
OptionalintentionallyNotDocumented
intentionallyNotDocumented?: string[]
OptionalintentionallyNotExported
intentionallyNotExported?: string[]
OptionaljsDocCompatibility
OptionalmaxTypeConversionDepth
maxTypeConversionDepth?: number
modifierTags?: `@${string}`[]
Optionalname
name?: string
Optionaloptions
options?: string
OptionalpackagesRequiringDocumentation
packagesRequiringDocumentation?: string[]
preservedTypeAnnotationTags?: `@${string}`[]
OptionalpreserveLinkText
preserveLinkText?: boolean
OptionalprojectDocuments
projectDocuments?: string[]
Optionalreadme
readme?: string
OptionalrequiredToBeDocumented
OptionalskipErrorChecking
skipErrorChecking?: boolean
Optionalsort
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"
)[]
OptionalsortEntryPoints
sortEntryPoints?: boolean
OptionalsourceLinkTemplate
sourceLinkTemplate?: string
suppressCommentWarningsInDeclarationFiles?: boolean
Optionaltsconfig
tsconfig?: string
OptionaluseTsLinkResolution
useTsLinkResolution?: boolean
Describes TypeDoc options suitable for setting within the
packageOptionssetting.This is a subset of all options specified in TypeDocOptions.