Docs
Example
GitHub
Preparing search index...
The search index is not available
TypeDoc API - v0.27.0
TypeDoc API
Configuration
KeyToDeclaration
Type Alias KeyToDeclaration<K>
KeyToDeclaration
:
Configuration
.
TypeDocOptionMap
[
K
]
extends
boolean
?
Configuration
.
BooleanDeclarationOption
:
Configuration
.
TypeDocOptionMap
[
K
]
extends
string
?
Configuration
.
StringDeclarationOption
:
Configuration
.
TypeDocOptionMap
[
K
]
extends
number
?
Configuration
.
NumberDeclarationOption
:
Configuration
.
TypeDocOptionMap
[
K
]
extends
string
[]
?
Configuration
.
ArrayDeclarationOption
:
unknown
extends
Configuration
.
TypeDocOptionMap
[
K
]
?
|
Configuration
.
MixedDeclarationOption
|
Configuration
.
ObjectDeclarationOption
:
Configuration
.
TypeDocOptionMap
[
K
]
extends
Configuration
.
ManuallyValidatedOption
<
unknown
,
>
?
|
Configuration
.
MixedDeclarationOption
&
{
validate
(
value
:
unknown
,
i18n
:
TranslationProxy
)
:
void
;
}
|
Configuration
.
ObjectDeclarationOption
&
{
validate
(
value
:
unknown
,
i18n
:
TranslationProxy
)
:
void
;
}
:
Configuration
.
TypeDocOptionMap
[
K
]
extends
Record
<
string
,
boolean
>
?
Configuration
.
FlagsDeclarationOption
<
Configuration
.
TypeDocOptionMap
[
K
]
,
>
:
Configuration
.
TypeDocOptionMap
[
K
]
extends
Record
<
string
|
number
,
infer
U
,
>
?
Configuration
.
MapDeclarationOption
<
U
>
:
never
Converts a given TypeDoc option key to the type of the declaration expected.
Type Parameters
K
extends
keyof
Configuration
.
TypeDocOptionMap
Settings
Member Visibility
Protected
Inherited
Internal
Theme
OS
Light
Dark
Docs
Example
GitHub
TypeDoc API - v0.27.0
Loading...
Converts a given TypeDoc option key to the type of the declaration expected.