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 ContainerReflection.children and parent properties to walk the tree. The groups property contains a list of all children grouped and sorted for being rendered.
The name of the anchor of this child. TODO: Reflections shouldn't know anchors exist. Move this to a serializer.
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.
A list of all types that are decorated by this reflection.
A list of all decorators attached to this reflection.
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.
Unique id of this reflection.
The kind of this reflection.
The human readable string representation of the kind of this reflection. Set during the resolution phase by GroupPlugin
The symbol name of this reflection.
The original name of the TypeScript declaration.
The reflection this reflection is a child of.
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.
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.
Separator used to join the names of the reflections.
The full name of this reflection.
Has this reflection a visible comment?
TRUE when this reflection has a visible comment.
Return whether this reflection is the root / project reflection.
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.
Generated using TypeDoc