Optional parent: Models.ReflectionInternal conversionFlags for information about a reflection which is needed solely during conversion.
Unique id of this reflection.
The kind of this reflection.
The symbol name of this reflection.
Readonly variantDiscriminator representing the type of reflection represented by this object.
Optional anchorThe name of the anchor of this child. TODO: Reflections shouldn't know anchors exist. Move this to a serializer.
Optional categoriesAll children grouped by their category.
Optional childrenThe children of this reflection.
Optional commentThe parsed documentation comment attached to this reflection.
Optional defaultThe default value of this reflection.
Applies to function parameters, variables, and properties.
Optional Internal escapedThe escaped name of this declaration assigned by the TS compiler if there is an associated symbol. This is used to retrieve properties for analyzing inherited members.
Not serialized, only useful during conversion.
Optional extendedA list of all types that extend this reflection (e.g. the subclasses).
Optional extendedA list of all types this reflection extends (e.g. the parent classes).
Optional getThe get signature of this declaration.
Optional groupsAll children grouped by their kind.
Optional hasIs the url pointing to an individual document?
When FALSE, the url points to an anchor tag on a page of a different reflection. TODO: Reflections shouldn't know how they are rendered. Move this to the correct serializer.
Optional implementationA type that points to the reflection this reflection is the implementation of.
Applies to class members.
Optional implementedA list of all types that implement this reflection.
Optional implementedA list of all types this reflection implements.
Optional indexThe index signature of this declaration.
Optional inheritedA type that points to the reflection this reflection has been inherited from.
Applies to interface and class members.
Optional overwritesA type that points to the reflection that has been overwritten by this reflection.
Applies to interface and class members.
Optional packageThe version of the module when found.
Optional parentThe reflection this reflection is a child of.
Optional readmeThe contents of the readme file of the module when found.
Optional relevanceA precomputed boost derived from the searchCategoryBoosts and searchGroupBoosts options, used when boosting search relevance scores at runtime. May be modified by plugins.
Optional setThe set signature of this declaration.
Optional signaturesA list of call signatures attached to this declaration.
TypeDoc creates one declaration per function that may contain one or more signature reflections.
Optional sourcesA list of all source files that contributed to this reflection.
Optional typeThe type of the reflection.
If the reflection represents a variable or a property, this is the value type.
If the reflection represents a signature, this is the return type.
Optional typeContains a simplified representation of the type hierarchy suitable for being rendered in templates.
Optional typeOptional urlThe url of this reflection in the generated documentation. TODO: Reflections shouldn't know urls exist. Move this to a serializer.
Return a child by its name.
The name hierarchy of the child to look for.
The found child or undefined.
Return a list of all children of a certain kind.
The desired kind of children.
An array containing all children with the desired kind.
Return the full name of this reflection. Intended for use in debugging. For log messages intended to be displayed to the user for them to fix, prefer getFriendlyFullName instead.
The full name contains the name of this reflection and the names of all parent reflections.
Separator used to join the names of the reflections.
The full name of this reflection.
Internal Return whether this reflection is the root / project reflection.
Test whether this reflection is of the given kind.
Set a flag on this reflection.
Traverse most potential child reflections of this reflection.
Note: This may not necessarily traverse child reflections contained within the type property
of the reflection, and should not be relied on for this. Support for checking object types will likely be removed in v0.26.
The given callback will be invoked for all children, signatures and type parameters attached to this reflection.
The callback function that should be applied for each child reflection.
A reflection that represents a single declaration emitted by the TypeScript compiler.
All parts of a project are represented by DeclarationReflection instances. The actual kind of a reflection is stored in its ´kind´ member.