Properties
base Path
base Path: string
block Tags
block Tags: ` @ ${ string } ` []
categorize By Group
categorize By Group: boolean
category Order
category Order: string []
clean Output Dir
clean Output Dir: boolean
comment Style
comment Style: { All: "all" ; Block: "block" ; JSDoc: "jsdoc" ; Line: "line" ; }
Type declaration
All: "all"
Block: "block"
JSDoc: "jsdoc"
Line: "line"
compiler Options
compiler Options: unknown
custom Css
custom Css: string
dark Highlight Theme
dark Highlight Theme: Theme
default Category
default Category: string
disable Sources
disable Sources: boolean
emit
emit: { both: "both" ; docs: "docs" ; none: "none" ; }
Type declaration
both: "both"
docs: "docs"
none: "none"
entry Point Strategy
entry Point Strategy: { Expand: "expand" ; Packages: "packages" ; Resolve: "resolve" ; }
Type declaration
Expand: "expand"
Packages: "packages"
Resolve: "resolve"
entry Points
entry Points: string []
exclude
exclude: string []
exclude Externals
exclude Externals: boolean
exclude Internal
exclude Internal: boolean
exclude Not Documented
exclude Not Documented: boolean
exclude Private
exclude Private: boolean
exclude Protected
exclude Protected: boolean
exclude Tags
exclude Tags: ` @ ${ string } ` []
external Pattern
external Pattern: string []
external Symbol Link Mappings
git Remote
git Remote: string
git Revision
git Revision: string
github Pages
github Pages: boolean
hide Generator
hide Generator: boolean
html Lang
html Lang: string
include Version
include Version: boolean
includes
includes: string
inline Tags
inline Tags: ` @ ${ string } ` []
intentionally Not Exported
intentionally Not Exported: string []
kind Sort Order
kind Sort Order: ( "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" ) []
light Highlight Theme
light Highlight Theme: Theme
marked Options
marked Options: unknown
modifier Tags
modifier Tags: ` @ ${ string } ` []
preserve Watch Output
preserve Watch Output: boolean
required To Be Documented
required To Be Documented: ( "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" ) []
search In Comments
search In Comments: boolean
show Config
show Config: boolean
skip Error Checking
skip Error Checking: boolean
sort
sort: ( "kind" | "source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "static-first" | "instance-first" | "visibility" | "required-first" ) []
source Link Template
source Link Template: string
title Link
title Link: string
treat Warnings As Errors
treat Warnings As Errors: boolean
tsconfig
tsconfig: string
visibility Filters
visibility
Filters
: ManuallyValidatedOption < { external
?: boolean ; inherited
?: boolean ; private
?: boolean ; protected
?: boolean ; [tag:
` @ ${ string } ` ]
: boolean ; } >
Describes all TypeDoc options. Used internally to provide better types when fetching options. External consumers should likely use TypeDocOptions instead.