Docs
Example
GitHub
Preparing search index...
The search index is not available
TypeDoc - v0.27.9
TypeDoc
Icons
Interface Icons
interface
Icons
{
"1"
:
()
=>
Element
;
"1024"
:
()
=>
Element
;
"1048576"
:
()
=>
Element
;
"128"
:
()
=>
Element
;
"131072"
:
()
=>
Element
;
"16"
:
()
=>
Element
;
"16384"
:
()
=>
Element
;
"2"
:
()
=>
Element
;
"2048"
:
()
=>
Element
;
"2097152"
:
()
=>
Element
;
"256"
:
()
=>
Element
;
"262144"
:
()
=>
Element
;
"32"
:
()
=>
Element
;
"32768"
:
()
=>
Element
;
"4"
:
()
=>
Element
;
"4096"
:
()
=>
Element
;
"4194304"
:
()
=>
Element
;
"512"
:
()
=>
Element
;
"524288"
:
()
=>
Element
;
"64"
:
()
=>
Element
;
"65536"
:
()
=>
Element
;
"8"
:
()
=>
Element
;
"8192"
:
()
=>
Element
;
"8388608"
:
()
=>
Element
;
alertCaution
()
:
Element
;
alertImportant
()
:
Element
;
alertNote
()
:
Element
;
alertTip
()
:
Element
;
alertWarning
()
:
Element
;
anchor
()
:
Element
;
checkbox
()
:
Element
;
chevronDown
()
:
Element
;
chevronSmall
()
:
Element
;
folder
()
:
Element
;
menu
()
:
Element
;
search
()
:
Element
;
}
Hierarchy
Record
<
Models
.
ReflectionKind
,
()
=>
Element
>
Icons
Index
Methods
alert
Caution
alert
Important
alert
Note
alert
Tip
alert
Warning
anchor
checkbox
chevron
Down
chevron
Small
folder
menu
search
Properties
1
1024
1048576
128
131072
16
16384
2
2048
2097152
256
262144
32
32768
4
4096
4194304
512
524288
64
65536
8
8192
8388608
Methods
alert
Caution
alertCaution
()
:
Element
Returns
Element
alert
Important
alertImportant
()
:
Element
Returns
Element
alert
Note
alertNote
()
:
Element
Returns
Element
alert
Tip
alertTip
()
:
Element
Returns
Element
alert
Warning
alertWarning
()
:
Element
Returns
Element
anchor
anchor
()
:
Element
Returns
Element
checkbox
checkbox
()
:
Element
Returns
Element
chevron
Down
chevronDown
()
:
Element
Returns
Element
chevron
Small
chevronSmall
()
:
Element
Returns
Element
folder
folder
()
:
Element
Returns
Element
menu
menu
()
:
Element
Returns
Element
search
search
()
:
Element
Returns
Element
Properties
1
"1"
:
()
=>
Element
1024
"1024"
:
()
=>
Element
1048576
"1048576"
:
()
=>
Element
128
"128"
:
()
=>
Element
131072
"131072"
:
()
=>
Element
16
"16"
:
()
=>
Element
16384
"16384"
:
()
=>
Element
2
"2"
:
()
=>
Element
2048
"2048"
:
()
=>
Element
2097152
"2097152"
:
()
=>
Element
256
"256"
:
()
=>
Element
262144
"262144"
:
()
=>
Element
32
"32"
:
()
=>
Element
32768
"32768"
:
()
=>
Element
4
"4"
:
()
=>
Element
4096
"4096"
:
()
=>
Element
4194304
"4194304"
:
()
=>
Element
512
"512"
:
()
=>
Element
524288
"524288"
:
()
=>
Element
64
"64"
:
()
=>
Element
65536
"65536"
:
()
=>
Element
8
"8"
:
()
=>
Element
8192
"8192"
:
()
=>
Element
8388608
"8388608"
:
()
=>
Element
Settings
Member Visibility
Protected
Inherited
Internal
Theme
OS
Light
Dark
On This Page
Methods
alert
Caution
alert
Important
alert
Note
alert
Tip
alert
Warning
anchor
checkbox
chevron
Down
chevron
Small
folder
menu
search
Properties
1
1024
1048576
128
131072
16
16384
2
2048
2097152
256
262144
32
32768
4
4096
4194304
512
524288
64
65536
8
8192
8388608
Docs
Example
GitHub
TypeDoc - v0.27.9
typescript
CheckFlags
Node
Signature
Symbol
Type
UnionType
getAllSuperTypeNodes
getCheckFlags
getInterfaceBaseTypeNodes
getJSDocCommentsAndTags
Configuration
OptionDefaults
blockTags
cascadedModifierTags
excludeNotDocumentedKinds
excludeTags
highlightLanguages
ignoredHighlightLanguages
inlineTags
kindSortOrder
modifierTags
notRenderedTags
requiredToBeDocumented
sort
CommentStyle
EmitStrategy
ParameterHint
ParameterType
ArgumentsReader
Options
PackageJsonReader
TSConfigReader
TypeDocReader
ArrayDeclarationOption
BooleanDeclarationOption
DeclarationOptionBase
FlagsDeclarationOption
MapDeclarationOption
MixedDeclarationOption
NumberDeclarationOption
ObjectDeclarationOption
OptionsReader
ParameterTypeToOptionTypeMap
StringDeclarationOption
TypeDocOptionMap
TypeDocOptions
TypeDocOptionValues
DeclarationOption
DeclarationOptionToOptionType
JsDocCompatibility
KeyToDeclaration
ManuallyValidatedOption
OutputSpecification
ValidationOptions
Option
Internationalization
Internationalization
TranslatableStrings
TranslatedString
TranslationProxy
JSONOutput
Reflections
ContainerReflection
DeclarationReflection
DocumentReflection
ParameterReflection
ProjectReflection
ReferenceReflection
Reflection
ReflectionVariantMap
SignatureReflection
TypeParameterReflection
SomeReflection
Types
ArrayType
ConditionalType
IndexedAccessType
InferredType
IntersectionType
IntrinsicType
LiteralType
MappedType
NamedTupleMemberType
OptionalType
PredicateType
QueryType
ReferenceType
ReflectionType
RestType
TemplateLiteralType
TupleType
Type
TypeOperatorType
UnionType
UnknownType
SomeType
TypeKindMap
Comments
Comment
CommentTag
InlineTagDisplayPart
CommentDisplayPart
Other
FileRegistry
ReflectionCategory
ReflectionFlags
ReflectionGroup
ReflectionSymbolId
RelativeLinkDisplayPart
SourceReference
ModelToObject
JSX
Element
Children
JsxComponent
createElement
Raw
renderElement
renderElementToText
setRenderSettings
Models
Reflections
ReflectionKind
KindString
All
ClassMember
ClassOrInterface
ContainsCallSignatures
ExportContainer
FunctionOrMethod
Inheritable
MayContainDocuments
MethodContainer
SignatureContainer
SomeExport
SomeMember
SomeModule
SomeSignature
SomeType
SomeValue
TypeReferenceTarget
ValueReferenceTarget
VariableContainer
VariableOrProperty
classString
pluralString
singularString
ReflectionKind
ContainerReflection
DeclarationReflection
ParameterReflection
ProjectReflection
ReferenceReflection
Reflection
SignatureReflection
TypeParameterReflection
Types
ArrayType
ConditionalType
IndexedAccessType
InferredType
IntersectionType
IntrinsicType
LiteralType
MappedType
NamedTupleMember
OptionalType
PredicateType
QueryType
ReferenceType
ReflectionType
RestType
TemplateLiteralType
TupleType
Type
TypeOperatorType
UnionType
UnknownType
TypeKindMap
SomeType
TypeKind
Comments
Comment
CommentTag
InlineTagDisplayPart
RelativeLinkDisplayPart
CommentDisplayPart
Other
ReflectionFlag
TraverseProperty
TypeContext
VarianceModifier
DocumentReflection
FileRegistry
ReflectionCategory
ReflectionFlags
ReflectionGroup
ReflectionSymbolId
SourceReference
ValidatingFileRegistry
DeclarationHierarchy
ReflectionVariant
TraverseCallback
ReflectionId
ReflectionSymbolIdString
ReflectionVisitor
SomeReflection
TypeVisitor
makeRecursiveVisitor
splitUnquotedString
EntryPointStrategy
LogLevel
Application
Context
Converter
DefaultTheme
DefaultThemeRenderContext
Deserializer
EventDispatcher
EventHooks
IndexEvent
Logger
MarkdownEvent
MinimalSourceFile
Outputs
PageEvent
Renderer
RendererEvent
SerializeEvent
Serializer
Slugger
Theme
UrlMapping
ApplicationEvents
CommentParserConfig
ComponentPath
ConverterEvents
DeclarationReference
Deserializable
DeserializerComponent
DocumentationEntryPoint
Icons
Meaning
NavigationElement
PageHeading
RendererEvents
RendererHooks
SerializerComponent
SerializerEvents
SymbolReference
EnumKeys
ExternalResolveResult
ExternalSymbolResolver
MeaningKeyword
RenderTemplate
SortStrategy
normalizePath
resetReflectionID
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R