Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

All children grouped by their category.

The children of this reflection.

The parsed documentation comment attached to this reflection.

decorates?: JSONOutput.SomeType[]

A list of all types that are decorated by this reflection.

decorators?: JSONOutput.Decorator[]
defaultValue?: string

The default value of this reflection.

Applies to function parameters.

extendedBy?: JSONOutput.ReferenceType[]

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

extendedTypes?: JSONOutput.SomeType[]

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

getSignature?: [undefined | JSONOutput.SignatureReflection]

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.

implementedTypes?: JSONOutput.SomeType[]

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.

setSignature?: [undefined | JSONOutput.SignatureReflection]

A list of call signatures attached to this declaration.

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

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