Properties
base base : string
block block : ` @ ${ string } ` []
cache cache : boolean
categorize categorize : boolean
category category : string []
clean clean : boolean
comment comment : "all" | "All" | "line" | "jsdoc" | "block" | "JSDoc" | "Block" | "Line"
compiler compiler : unknown
custom custom : string
dark dark : Theme
default default : string
disable disable : boolean
emit emit : "none" | "both" | "docs"
entry entry : "packages" | "resolve" | "expand" | "legacy-packages" | "merge" | "Resolve" | "Expand" | "Packages" | "LegacyPackages" | "Merge"
entry entry : string []
exclude exclude : string []
exclude exclude : boolean
exclude exclude : boolean
exclude exclude : boolean
exclude exclude : ( "All" | "Parameter" | "Enum" | "Project" | "Module" | "Namespace" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "Reference" | "singularString" | "pluralString" | "classString" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer" ) []
exclude exclude : boolean
exclude exclude : boolean
exclude exclude : boolean
exclude exclude : ` @ ${ string } ` []
external external : string []
external external : Record < string , Record < string , string > >
git git : string
git git : string
github github : boolean
group group : string []
hide hide : boolean
hide hide : boolean
html html : string
include include : boolean
includes includes : string
inline inline : ` @ ${ string } ` []
intentionally intentionally : string []
kind kind : ( "All" | "Parameter" | "Enum" | "Project" | "Module" | "Namespace" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "Reference" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer" ) []
light light : Theme
marked marked : unknown
modifier modifier : ` @ ${ string } ` []
navigation navigation : boolean | Partial < { Â Â Â Â includeCategories : boolean ; Â Â Â Â includeGroups : boolean ; } >
navigation navigation : Record < string , string >
preserve preserve : boolean
required required : ( "All" | "Parameter" | "Enum" | "Project" | "Module" | "Namespace" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "ObjectLiteral" | "TypeAlias" | "Reference" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "SignatureContainer" ) []
search search : Record < string , number >
search search : Record < string , number >
search search : boolean
show show : boolean
sidebar sidebar : Record < string , string >
skip skip : boolean
sort sort : ( "kind" | "source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "enum-member-source-order" | "static-first" | "instance-first" | "visibility" | "required-first" ) []
source source : string
title title : string
treat treat : boolean
treat treat : boolean
tsconfig tsconfig : string
use use : boolean
visibility visibility : { Â Â Â Â external ?: boolean ; Â Â Â Â inherited ?: boolean ; Â Â Â Â private ?: boolean ; Â Â Â Â protected ?: boolean ; Â Â Â Â [tag : ` @ ${ string } ` ]: boolean ; }
Type declaration
[ tag : ` @ ${ string } ` ]: boolean
Optional external ?: boolean
Optional inherited ?: boolean
Optional private ?: boolean
Optional protected ?: boolean
An interface describing all TypeDoc specific options. Generated from a map which contains more information about each option for better types when defining said options.