Optionalparent: Models.ReflectionReturn 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.
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.27.
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.
Unique id of this reflection.
The kind of this reflection.
The symbol name of this reflection.
ReadonlyvariantDiscriminator representing the type of reflection represented by this object.
OptionalanchorThe name of the anchor of this child. TODO: Reflections shouldn't know anchors exist. Move this to a serializer.
OptionalcategoriesAll children grouped by their category.
OptionalchildrenThe children of this reflection. Do not add reflections to this array manually. Instead call addChild.
OptionalchildrenOptionalcommentThe parsed documentation comment attached to this reflection.
OptionaldefaultThe default value of this reflection.
Applies to function parameters, variables, and properties.
OptionaldocumentsDocuments associated with this reflection.
These are not children as including them as children requires code handle both types, despite being mostly unrelated and handled separately.
Including them here in a separate array neatly handles that problem, but also introduces another one for rendering. When rendering, documents should really actually be considered part of the "children" of a reflection. For this reason, we also maintain a list of child declarations with child documents which is used when rendering.
Optional InternalescapedThe 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.
OptionalextendedA list of all types that extend this reflection (e.g. the subclasses).
OptionalextendedA list of all types this reflection extends (e.g. the parent classes).
OptionalgetThe get signature of this declaration.
OptionalgroupsAll children grouped by their kind.
OptionalhasIs 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.
OptionalimplementationA type that points to the reflection this reflection is the implementation of.
Applies to class members.
OptionalimplementedA list of all types that implement this reflection.
OptionalimplementedA list of all types this reflection implements.
OptionalindexThe index signature of this declaration.
OptionalinheritedA type that points to the reflection this reflection has been inherited from.
Applies to interface and class members.
OptionaloverwritesA type that points to the reflection that has been overwritten by this reflection.
Applies to interface and class members.
OptionalpackageThe version of the module when found.
OptionalparentThe reflection this reflection is a child of.
OptionalreadmeThe contents of the readme file of the module when found.
OptionalrelevancePrecomputed boost for search results, may be less than 1 to de-emphasize this member in search results. Does NOT include group/category values as they are computed when building the JS index.
This is preserved for plugins, and may be removed in 0.28 if no plugins have used it yet.
OptionalsetThe set signature of this declaration.
OptionalsignaturesA list of call signatures attached to this declaration.
TypeDoc creates one declaration per function that may contain one or more signature reflections.
OptionalsourcesA list of all source files that contributed to this reflection.
OptionaltypeThe 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.
OptionaltypeContains a simplified representation of the type hierarchy suitable for being rendered in templates.
OptionaltypeOptionalurlThe url of this reflection in the generated documentation. TODO: Reflections shouldn't know urls exist. Move this to a serializer.
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.