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.
Unique id of this reflection.
The kind of this reflection.
The symbol name of this reflection.
This may be replaced with a
Map<number, Reflection> someday.
Discriminator representing the type of reflection represented by this object.
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.
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 name of the package that this reflection documents according to package.json.
The version of the package that this reflection documents according to package.json.
The reflection this reflection is a child of.
The contents of the readme.md file of the project when found.
The url of this reflection in the generated documentation. TODO: Reflections shouldn't know urls exist. Move this to a serializer.
Return an url safe alias for this reflection.
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.
Separator used to join the names of the reflections.
The full name of this reflection.
THIS MAY NOT BE USED AFTER CONVERSION HAS FINISHED.
Has this reflection a visible comment?
TRUE when this reflection has a visible comment.
Check if this reflection or any of its parents have been marked with the
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.
Removes 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.
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 most potential child reflections of this reflection.
Note: This may not necessarily traverse child reflections contained within the
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.
Generated using TypeDoc