AbstractOptionalparent: Models.ReflectionReturn a child by its name.
The name hierarchy of the child to look for.
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.
Check if this reflection or any of its parents have been marked with the @deprecated tag.
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.
Note: This is intended as a debug tool only, output may change between patch versions.
Used internally to indent child reflections.
AbstracttraverseTraverse 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.29.
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.
Unique id of this reflection.
The kind of this reflection.
The symbol name of this reflection.
Abstract ReadonlyvariantDiscriminator representing the type of reflection represented by this object.
OptionalcommentThe parsed documentation comment attached to this reflection.
OptionalparentThe reflection this reflection is a child of.
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 ContainerReflection.groups property contains a list of all children grouped and sorted for rendering.