Base class for all reflection classes.
While generating a documentation, TypeDoc generates an instance of ProjectReflection as the root for all reflections within the project. All other reflections are represented by the DeclarationReflection class.
This base class exposes the basic properties one may use to traverse the reflection tree. You can use the children and parent properties to walk the tree. The groups property contains a list of all children grouped and sorted for rendering.
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.
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.
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.
The reflection this reflection is a child of.
A precomputed boost derived from the searchCategoryBoosts and searchGroupBoosts options, used when boosting search relevance scores at runtime. May be modified by plugins.
A list of all source files that contributed to this reflection.
The url of this reflection in the generated documentation. TODO: Reflections shouldn't know urls exist. Move this to a serializer.
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 an url safe alias for this reflection.
Return a child by its name.
The found child or undefined.
Return the full name of this reflection, with signature names dropped if possible without introducing ambiguity in the name.
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.
Has this reflection a visible comment?
TRUE when this reflection has a visible comment.
Check if this reflection has been marked with the
Return whether this reflection is the root / project reflection.
Test whether this reflection is of the given kind.
Set a flag on this reflection.
Return a string representation of this reflection.
Return a string representation of this reflection and all of its children.
Used internally to indent child reflections.
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.
Generated using TypeDoc