Hierarchy

Properties

All children grouped by their category.

The children of this reflection.

The parsed documentation comment attached to this reflection.

defaultValue?: string

The default value of this reflection.

Applies to function parameters, variables, and properties.

extendedBy?: JSONOutput.ReferenceType[]

A list of all types that extend this reflection (e.g. the subclasses).

A list of all types this reflection extends (e.g. the parent classes).

The get signature of this declaration.

All children grouped by their kind.

id: number

Unique id of this reflection.

implementationOf?: JSONOutput.ReferenceType

A type that points to the reflection this reflection is the implementation of.

Applies to class members.

implementedBy?: JSONOutput.ReferenceType[]

A list of all types that implement this reflection.

A list of all types this reflection implements.

The index signature of this declaration.

inheritedFrom?: JSONOutput.ReferenceType

A type that points to the reflection this reflection has been inherited from.

Applies to interface and class members.

The kind of this reflection.

kindString?: string

The human readable string representation of the kind of this reflection. Set during the resolution phase by GroupPlugin

name: string

The symbol name of this reflection.

originalName?: string

Will not be present if name === originalName

A type that points to the reflection that has been overwritten by this reflection.

Applies to interface and class members.

The set signature of this declaration.

A list of call signatures attached to this declaration.

TypeDoc creates one declaration per function that may contain one or more signature reflections.

A list of all source files that contributed to this reflection.

target: number

-1 if the reference refers to a symbol that does not exist in the documentation. Otherwise, the reflection ID.

The 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.

Generated using TypeDoc