OptionalcategoriesOptionalchildrenThe children of this reflection. Do not add reflections to this array manually. Instead call addChild.
OptionalchildrenOptionalcommentThe parsed documentation comment attached to this reflection.
OptionaldefaultThe default value of this reflection.
Applies to function parameters, variables, and properties.
OptionaldocumentsDocuments associated with this reflection.
These are not children as including them as children requires code handle both types, despite being mostly unrelated and handled separately.
Including them here in a separate array neatly handles that problem, but also introduces another one for rendering. When rendering, documents should really actually be considered part of the "children" of a reflection. For this reason, we also maintain a list of child declarations with child documents which is used when rendering.
OptionalextendedA list of all types that extend this reflection (e.g. the subclasses).
OptionalextendedA list of all types this reflection extends (e.g. the parent classes).
OptionalgetThe get signature of this declaration.
OptionalgroupsAll children grouped by their kind.
Unique id of this reflection.
OptionalimplementationA type that points to the reflection this reflection is the implementation of.
Applies to class members.
OptionalimplementedA list of all types that implement this reflection.
OptionalimplementedA list of all types this reflection implements.
OptionalindexThe index signature of this declaration.
OptionalinheritedA type that points to the reflection this reflection has been inherited from.
Applies to interface and class members.
The kind of this reflection.
The symbol name of this reflection.
OptionaloverwritesA type that points to the reflection that has been overwritten by this reflection.
Applies to interface and class members.
OptionalpackageThe version of the module when found.
OptionalreadmeThe contents of the readme file of the module when found.
OptionalrelevancePrecomputed boost for search results, may be less than 1 to de-emphasize this member in search results. Does NOT include group/category values as they are computed when building the JS index.
This is exposed purely for plugin use, see #3036 for details.
OptionalsetThe set signature of this declaration.
OptionalsignaturesA list of call signatures attached to this declaration.
TypeDoc creates one declaration per function that may contain one or more signature reflections.
OptionalsourcesA list of all source files that contributed to this reflection.
OptionaltypeThe type of the reflection.
If the reflection represents a variable or a property, this is the value type.
If the reflection represents a signature, this is the return type.
OptionaltypeReadonlyvariantDiscriminator representing the type of reflection represented by this object.
All children grouped by their category.