Properties block Tags block Tags : ` @ ${ string } ` []
cache Bust cache Bust : boolean
categorize By Group categorize By Group : boolean
category Order category Order : string []
clean Output Dir clean Output Dir : boolean
comment Style comment Style : "all" | "line" | "jsdoc" | "block"
compiler Options compiler Options : unknown
custom Css custom Css : string
dark Highlight Theme dark Highlight Theme : Theme
default Category default Category : string
disable Git disable Git : boolean
disable Sources disable Sources : boolean
emit emit : "none" | "both" | "docs"
entry Point Strategy entry Point Strategy : "packages" | "resolve" | "expand" | "merge"
entry Points entry Points : string []
exclude Categories exclude Categories : string []
exclude Externals exclude Externals : boolean
exclude Internal exclude Internal : boolean
exclude Not Documented exclude Not Documented : boolean
exclude Not Documented Kinds exclude Not Documented Kinds : ( "All" | "Parameter" | "Enum" | "Project" | "Module" | "Namespace" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "TypeAlias" | "Reference" | "singularString" | "pluralString" | "classString" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "TypeReferenceTarget" | "ValueReferenceTarget" | "SignatureContainer" | "VariableContainer" | "MethodContainer" ) []
exclude Private exclude Private : boolean
exclude Protected exclude Protected : boolean
exclude References exclude References : boolean
exclude Tags exclude Tags : ` @ ${ string } ` []
external Pattern external Pattern : string []
external Symbol Link Mappings external Symbol Link Mappings : Record < string , Record < string , string > >
git Remote git Remote : string
git Revision git Revision : string
github Pages github Pages : boolean
group Order group Order : string []
hide Generator hide Generator : boolean
hide Parameter Types In Title hide Parameter Types In Title : boolean
include Version include Version : boolean
inline Tags inline Tags : ` @ ${ string } ` []
intentionally Not Exported intentionally Not Exported : string []
kind Sort Order kind Sort Order : ( "All" | "Parameter" | "Enum" | "Project" | "Module" | "Namespace" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "TypeAlias" | "Reference" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "TypeReferenceTarget" | "ValueReferenceTarget" | "SignatureContainer" | "VariableContainer" | "MethodContainer" ) []
light Highlight Theme light Highlight Theme : Theme
marked Options marked Options : unknown
max Type Conversion Depth max Type Conversion Depth : number
modifier Tags modifier Tags : ` @ ${ string } ` []
navigation navigation : { fullTree : boolean ; includeCategories : boolean ; includeFolders : boolean ; includeGroups : boolean ; }
Type declaration full Tree : boolean include Categories : boolean include Folders : boolean include Groups : boolean navigation Leaves navigation Leaves : string []
navigation Links navigation Links : Record < string , string >
preserve Link Text preserve Link Text : boolean
preserve Watch Output preserve Watch Output : boolean
required To Be Documented required To Be Documented : ( "All" | "Parameter" | "Enum" | "Project" | "Module" | "Namespace" | "EnumMember" | "Variable" | "Function" | "Class" | "Interface" | "Constructor" | "Property" | "Method" | "CallSignature" | "IndexSignature" | "ConstructorSignature" | "TypeLiteral" | "TypeParameter" | "Accessor" | "GetSignature" | "SetSignature" | "TypeAlias" | "Reference" | "ClassOrInterface" | "VariableOrProperty" | "FunctionOrMethod" | "ClassMember" | "SomeSignature" | "SomeModule" | "SomeType" | "SomeValue" | "SomeMember" | "SomeExport" | "ExportContainer" | "Inheritable" | "ContainsCallSignatures" | "TypeReferenceTarget" | "ValueReferenceTarget" | "SignatureContainer" | "VariableContainer" | "MethodContainer" ) []
search Category Boosts search Category Boosts : Record < string , number >
search Group Boosts search Group Boosts : Record < string , number >
search In Comments search In Comments : boolean
show Config show Config : boolean
sidebar Links sidebar Links : Record < string , string >
sitemap Base Url sitemap Base Url : string
skip Error Checking skip Error Checking : boolean
sort sort : ( "kind" | "source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "enum-member-source-order" | "static-first" | "instance-first" | "visibility" | "required-first" | "external-last" ) []
sort Entry Points sort Entry Points : boolean
source Link External source Link External : boolean
source Link Template source Link Template : string
strip Yaml Frontmatter strip Yaml Frontmatter : boolean
title Link title Link : string
treat Validation Warnings As Errors treat Validation Warnings As Errors : boolean
treat Warnings As Errors treat Warnings As Errors : boolean
use Ts Link Resolution use Ts Link Resolution : boolean
visibility Filters visibility Filters : { 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
Describes all TypeDoc specific options as returned by Options.getValue, this is slightly more restrictive than the TypeDocOptions since it does not allow both keys and values for mapped option types, and does not allow partials of flag values.