Unique id of this reflection.
The kind of this reflection.
The symbol name of this reflection.
The original name of the TypeScript declaration.
A list of all reflections within the project. DO NOT MUTATE THIS OBJECT. All mutation should be done via registerReflection and removeReflection to ensure that links to reflections remain valid.
This may be replaced with a Map<number, Reflection> someday.
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 cssA 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.
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 kindThe human readable string representation of the kind of this reflection. Set during the resolution phase by GroupPlugin
Optional labelLabel associated with this reflection, if any (https://tsdoc.org/pages/tags/label/) Added by the CommentPlugin during resolution.
Optional parentThe reflection this reflection is a child of.
Optional readmeThe contents of the readme.md file of the project 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 sourcesA list of all source files that contributed to this reflection.
Optional urlThe 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 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 registered for the given reflection ID, or undefined if it is not present in the project.
Internal
Gets the reflection associated with the given symbol, if it exists.
Return a list of all reflections in this project of a certain kind.
An array containing all reflections with the desired kind.
The desired kind of reflection.
Internal
Return whether this reflection is the root / project reflection.
Test whether this reflection is of the given kind.
Registers the given reflection so that it can be quickly looked up by helper methods. Should be called for every reflection added to the project.
Optional symbol: SymbolRemoves a reflection from the documentation. Can be used by plugins to filter reflections out of the generated documentation. Has no effect if the reflection is not present in the project.
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.
Generated using TypeDoc
A reflection that represents the root of the project.
The project reflection acts as a global index, one may receive all reflections and source files of the processed project through this reflection.