Creates a reference reflection. Should only be used within the factory function.
Unique id of this reflection.
The kind of this reflection.
The symbol name of this reflection.
The original name of the TypeScript declaration.
The name of the anchor of this child. TODO: Reflections shouldn't know anchors exist. Move this to a serializer.
All children grouped by their category.
The children of this reflection.
The parsed documentation comment attached to this reflection.
A list of generated css classes that should be applied to representations of this reflection in the generated markup. TODO: Reflections shouldn't know about CSS. Move this property to the correct serializer.
The default value of this reflection.
Applies to function parameters, variables, and properties.
The 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.
A list of all types that extend this reflection (e.g. the subclasses).
A list of all types this reflection extends (e.g. the parent classes).
The get signature of this declaration.
All children grouped by their kind.
Is 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.
A type that points to the reflection this reflection is the implementation of.
Applies to class members.
A list of all types that implement this reflection.
A list of all types this reflection implements.
The index signature of this declaration.
A type that points to the reflection this reflection has been inherited from.
Applies to interface and class members.
The human readable string representation of the kind of this reflection. Set during the resolution phase by GroupPlugin
Label associated with this reflection, if any (https://tsdoc.org/pages/tags/label/) Added by the CommentPlugin during resolution.
A type that points to the reflection that has been overwritten by this reflection.
Applies to interface and class members.
The reflection this reflection is a child of.
The contents of the readme file of the module when found.
A precomputed boost derived from the searchCategoryBoosts and searchGroupBoosts options, used when boosting search relevance scores at runtime. May be modified by plugins.
The set signature of this declaration.
A list of call signatures attached to this declaration.
TypeDoc creates one declaration per function that may contain one or more signature reflections.
A list of all source files that contributed to this reflection.
The 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.
Contains a simplified representation of the type hierarchy suitable for being rendered in templates.
The url of this reflection in the generated documentation. TODO: Reflections shouldn't know urls exist. Move this to a serializer.
The version of the module when found.
Try to find a reflection by its name.
The found reflection or null.
This method not be used, it naively splits the name by a
. and searches recursively up
the parent tree, which is not how any other name resolver works. If you are currently using this and
need another method, please open an issue. For tests getChildByName should generally be sufficient.
Return a child by its name.
The found child or undefined.
Return a list of all children of a certain kind.
An array containing all children with the desired kind.
The desired kind of children.
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.
The full name of this reflection.
Separator used to join the names of the reflections.
Gets the reflection that is referenced. This may be another reference reflection. To fully resolve any references, use getTargetReflectionDeep.
Gets the reflection that is referenced, this will fully resolve references. To only resolve one reference, use getTargetReflection.
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 all potential child reflections of this reflection.
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.
Tries to get the reflection that is referenced. This may be another reference reflection. To fully resolve any references, use tryGetTargetReflectionDeep.
Tries to get the reflection that is referenced, this will fully resolve references. To only resolve one reference, use tryGetTargetReflection.
Generated using TypeDoc
Describes a reflection which does not exist at this location, but is referenced. Used for imported reflections.