Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional categories

All children grouped by their category.

Optional children

The children of this reflection.

Optional comment

The parsed documentation comment attached to this reflection.

Optional decorates

decorates?: JSONOutput.SomeType[]

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

Optional decorators

decorators?: JSONOutput.Decorator[]

Optional defaultValue

defaultValue?: string

The default value of this reflection.

Applies to function parameters.

Optional extendedBy

extendedBy?: JSONOutput.ReferenceType[]

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

Optional extendedTypes

extendedTypes?: JSONOutput.SomeType[]

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

flags

Optional getSignature

getSignature?: [undefined | JSONOutput.SignatureReflection]

Optional groups

All children grouped by their kind.

id

id: number

Unique id of this reflection.

Optional implementationOf

implementationOf?: JSONOutput.ReferenceType

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

Applies to class members.

Optional implementedBy

implementedBy?: JSONOutput.ReferenceType[]

A list of all types that implement this reflection.

Optional implementedTypes

implementedTypes?: JSONOutput.SomeType[]

A list of all types this reflection implements.

Optional indexSignature

The index signature of this declaration.

Optional inheritedFrom

inheritedFrom?: JSONOutput.ReferenceType

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

Applies to interface and class members.

kind

The kind of this reflection.

Optional kindString

kindString?: string

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

name

name: string

The symbol name of this reflection.

Optional originalName

originalName?: string

Will not be present if name === originalName

Optional overwrites

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

Applies to interface and class members.

Optional setSignature

setSignature?: [undefined | JSONOutput.SignatureReflection]

Optional signatures

A list of call signatures attached to this declaration.

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

Optional sources

Optional type

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.

Optional typeParameter

Generated using TypeDoc