Abstract
Optional
parent: Models.ReflectionThe kind of this reflection.
The symbol name of this reflection.
Readonly
Abstract
variantDiscriminator representing the type of reflection represented by this object.
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
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
parentThe reflection this reflection is a child of.
Optional
urlThe url of this reflection in the generated documentation. TODO: Reflections shouldn't know urls exist. Move this to a serializer.
Return a child by its name.
The found child or undefined.
Return a list of all children of a certain kind.
The desired kind of children.
An array containing all children with the desired kind.
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.
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 most potential child reflections of this reflection.
Note: This may not necessarily traverse child reflections contained within the type
property
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
Unique id of this reflection.