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.
Create a new ProjectReflection instance.
The name of the project.
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.
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.
The root directory of the project.
A list of all source files within the project.
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.
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 name of the project.
The name can be passed as a command line argument or it is read from the package info. this.name is assigned in the Reflection class.
The original name of the TypeScript declaration.
The parsed data of the package.json file of the project when found.
The reflection this reflection is a child of.
The contents of the readme.md file of the project when found.
A list of all reflections within the project.
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 undefined.
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.
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.
Gets the reflection registered for the given reflection ID, or undefined if it is not present in the project.
Has this reflection a visible comment?
TRUE when this reflection has a visible comment.
Return whether this reflection is the root / project reflection.
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.
When excludeNotExported is set, if a symbol is exported only under a different name there will be a reference which points to the symbol, but the symbol will not be converted and the rename will point to nothing. Warn the user if this happens.
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 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