TypeDoc API - v0.27.2

Common

Application

Root level class which contains most useful behavior.

Converter

Responsible for converting TypeScript symbols into Reflections and Types.

Deserializer

Deserializes TypeDoc's JSON output

Renderer

Writes HTML output from TypeDoc's models

Serializer

Serializes TypeDoc's models to JSON

Namespaces

Configuration

Controls how TypeDoc reads option files and what options are available.

Internationalization

Internationalization module for localized strings in output.

JSONOutput

Contains interfaces which describe the JSON output.

JSX

Custom JSX module designed specifically for TypeDoc's needs.

Models

TypeDoc converts source code into these object types.

OptionDefaults → Configuration.OptionDefaults

Classes

Context
DefaultTheme
DefaultThemeRenderContext
EventDispatcher
EventHooks
IndexEvent
Logger
MarkdownEvent
MinimalSourceFile
Outputs
PageEvent
RendererEvent
SerializeEvent
Slugger
Theme
UrlMapping
ArgumentsReader → Configuration.ArgumentsReader
ArrayType → Models.ArrayType
Comment → Models.Comment
CommentTag → Models.CommentTag
ConditionalType → Models.ConditionalType
ContainerReflection → Models.ContainerReflection
DeclarationReflection → Models.DeclarationReflection
DocumentReflection → Models.DocumentReflection
FileRegistry → Models.FileRegistry
IndexedAccessType → Models.IndexedAccessType
InferredType → Models.InferredType
IntersectionType → Models.IntersectionType
IntrinsicType → Models.IntrinsicType
LiteralType → Models.LiteralType
MappedType → Models.MappedType
NamedTupleMember → Models.NamedTupleMember
OptionalType → Models.OptionalType
Options → Configuration.Options
PackageJsonReader → Configuration.PackageJsonReader
ParameterReflection → Models.ParameterReflection
PredicateType → Models.PredicateType
ProjectReflection → Models.ProjectReflection
QueryType → Models.QueryType
ReferenceReflection → Models.ReferenceReflection
ReferenceType → Models.ReferenceType
Reflection → Models.Reflection
ReflectionCategory → Models.ReflectionCategory
ReflectionFlags → Models.ReflectionFlags
ReflectionGroup → Models.ReflectionGroup
ReflectionSymbolId → Models.ReflectionSymbolId
ReflectionType → Models.ReflectionType
RestType → Models.RestType
SignatureReflection → Models.SignatureReflection
SourceReference → Models.SourceReference
TemplateLiteralType → Models.TemplateLiteralType
TSConfigReader → Configuration.TSConfigReader
TupleType → Models.TupleType
Type → Models.Type
TypeDocReader → Configuration.TypeDocReader
TypeOperatorType → Models.TypeOperatorType
TypeParameterReflection → Models.TypeParameterReflection
UnionType → Models.UnionType
UnknownType → Models.UnknownType
ValidatingFileRegistry → Models.ValidatingFileRegistry

Enumerations

EntryPointStrategy
LogLevel
CommentStyle → Configuration.CommentStyle
ParameterHint → Configuration.ParameterHint
ParameterType → Configuration.ParameterType
ReflectionFlag → Models.ReflectionFlag
ReflectionKind → Models.ReflectionKind
TraverseProperty → Models.TraverseProperty
TypeContext → Models.TypeContext
VarianceModifier → Models.VarianceModifier

Functions

normalizePath
resetReflectionID
makeRecursiveVisitor → Models.makeRecursiveVisitor
Option → Configuration.Option
splitUnquotedString → Models.splitUnquotedString

Interfaces

ApplicationEvents
CommentParserConfig
ComponentPath
ConverterEvents
DeclarationReference
Deserializable
DeserializerComponent
DocumentationEntryPoint
Meaning
NavigationElement
PageHeading
RendererEvents
RendererHooks
SerializerComponent
SerializerEvents
SymbolReference
ArrayDeclarationOption → Configuration.ArrayDeclarationOption
BooleanDeclarationOption → Configuration.BooleanDeclarationOption
DeclarationHierarchy → Models.DeclarationHierarchy
DeclarationOptionBase → Configuration.DeclarationOptionBase
FlagsDeclarationOption → Configuration.FlagsDeclarationOption
InlineTagDisplayPart → Models.InlineTagDisplayPart
MapDeclarationOption → Configuration.MapDeclarationOption
MixedDeclarationOption → Configuration.MixedDeclarationOption
NumberDeclarationOption → Configuration.NumberDeclarationOption
ObjectDeclarationOption → Configuration.ObjectDeclarationOption
OptionsReader → Configuration.OptionsReader
ParameterTypeToOptionTypeMap → Configuration.ParameterTypeToOptionTypeMap
ReflectionVariant → Models.ReflectionVariant
RelativeLinkDisplayPart → Models.RelativeLinkDisplayPart
StringDeclarationOption → Configuration.StringDeclarationOption
TranslatableStrings → Internationalization.TranslatableStrings
TraverseCallback → Models.TraverseCallback
TypeDocOptionMap → Configuration.TypeDocOptionMap
TypeDocOptions → Configuration.TypeDocOptions
TypeDocOptionValues → Configuration.TypeDocOptionValues
TypeKindMap → Models.TypeKindMap

Type Aliases

EnumKeys
ExternalResolveResult
ExternalSymbolResolver
MeaningKeyword
RenderTemplate
SortStrategy
CommentDisplayPart → Models.CommentDisplayPart
DeclarationOption → Configuration.DeclarationOption
DeclarationOptionToOptionType → Configuration.DeclarationOptionToOptionType
JsDocCompatibility → Configuration.JsDocCompatibility
KeyToDeclaration → Configuration.KeyToDeclaration
ManuallyValidatedOption → Configuration.ManuallyValidatedOption
OutputSpecification → Configuration.OutputSpecification
ReflectionId → Models.ReflectionId
ReflectionSymbolIdString → Models.ReflectionSymbolIdString
ReflectionVisitor → Models.ReflectionVisitor
SomeReflection → Models.SomeReflection
SomeType → Models.SomeType
TypeKind → Models.TypeKind
TypeVisitor → Models.TypeVisitor
ValidationOptions → Configuration.ValidationOptions