TypeDoc API - v0.28.2
Docs
Example
GitHub
Configuration
OptionDefaults
Namespace OptionDefaults
Defaults values for TypeDoc options
Variables
blockTags
cascadedModifierTags
excludeNotDocumentedKinds
excludeTags
highlightLanguages
ignoredHighlightLanguages
inlineTags
kindSortOrder
modifierTags
notRenderedTags
requiredToBeDocumented
sort
Settings
Member Visibility
Protected
Inherited
Internal
Theme
OS
Light
Dark
On This Page
Variables
block
Tags
cascaded
Modifier
Tags
exclude
Not
Documented
Kinds
exclude
Tags
highlight
Languages
ignored
Highlight
Languages
inline
Tags
kind
Sort
Order
modifier
Tags
not
Rendered
Tags
required
To
Be
Documented
sort
Docs
Example
GitHub
TypeDoc API - v0.28.2
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
GlobArrayDeclarationOption
MapDeclarationOption
MixedDeclarationOption
NumberDeclarationOption
ObjectDeclarationOption
OptionsReader
ParameterTypeToOptionTypeMap
StringDeclarationOption
TypeDocOptionMap
TypeDocOptions
TypeDocOptionValues
TypeDocPackageOptions
DeclarationOption
DeclarationOptionToOptionType
JsDocCompatibility
KeyToDeclaration
ManuallyValidatedOption
OutputSpecification
ValidationOptions
Option
Internationalization
Internationalization
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
SCHEMA_VERSION
JSX
Element
Children
JsxComponent
createElement
Fragment
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
DeclarationHierarchy
ReflectionVariant
TraverseCallback
ReflectionId
ReflectionSymbolIdString
ReflectionVisitor
SomeReflection
TypeVisitor
makeRecursiveVisitor
resetReflectionID
splitUnquotedString
EntryPointStrategy
LogLevel
PageKind
Application
BaseRouter
CategoryRouter
ConsoleLogger
Context
Converter
DefaultTheme
DefaultThemeRenderContext
Deserializer
EventDispatcher
EventHooks
FancyConsoleLogger
GroupRouter
IndexEvent
KindDirRouter
KindRouter
Logger
MarkdownEvent
MinimalSourceFile
Outputs
PageEvent
Renderer
RendererEvent
SerializeEvent
Serializer
Slugger
StructureDirRouter
StructureRouter
Theme
ValidatingFileRegistry
ApplicationEvents
CommentParserConfig
ComponentPath
ConverterEvents
DeclarationReference
Deserializable
DeserializerComponent
DocumentationEntryPoint
Icons
Meaning
MinimalNode
NavigationElement
PageDefinition
PageHeading
RendererEvents
RendererHooks
Router
SerializerComponent
SerializerEvents
SymbolReference
TranslatableStrings
EnumKeys
ExternalResolveResult
ExternalSymbolResolver
GlobString
MeaningKeyword
NormalizedPath
NormalizedPathOrModule
RenderTemplate
RouterTarget
SortStrategy
TranslatedString
i18n
normalizePath
translateTagName
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R
Defaults values for TypeDoc options