Class DeclarationReflection

A reflection that represents a single declaration emitted by the TypeScript compiler.

All parts of a project are represented by DeclarationReflection instances. The actual kind of a reflection is stored in its ┬┤kind┬┤ member.

Hierarchy

Constructors

Properties

conversionFlags: ConversionFlags = ConversionFlags.None

Flags for information about a reflection which is needed solely during conversion.

flags: ReflectionFlags = ...
id: number

Unique id of this reflection.

The kind of this reflection.

name: string

The symbol name of this reflection.

originalName: string

The original name of the TypeScript declaration.

anchor?: string

The name of the anchor of this child. TODO: Reflections shouldn't know anchors exist. Move this to a serializer.

categories?: ReflectionCategory[]

All children grouped by their category.

The children of this reflection.

comment?: Comment

The parsed documentation comment attached to this reflection.

cssClasses?: string

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.

defaultValue?: string

The default value of this reflection.

Applies to function parameters, variables, and properties.

escapedName?: __String

The escaped name of this declaration assigned by the TS compiler if there is an associated symbol. This is used to retrieve properties for analyzing inherited members.

extendedBy?: ReferenceType[]

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

extendedTypes?: SomeType[]

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

getSignature?: SignatureReflection

The get signature of this declaration.

groups?: ReflectionGroup[]

All children grouped by their kind.

hasOwnDocument?: boolean

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.

implementationOf?: ReferenceType

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

Applies to class members.

implementedBy?: ReferenceType[]

A list of all types that implement this reflection.

implementedTypes?: SomeType[]

A list of all types this reflection implements.

indexSignature?: SignatureReflection

The index signature of this declaration.

inheritedFrom?: ReferenceType

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

Applies to interface and class members.

kindString?: string

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

label?: string

Label associated with this reflection, if any (https://tsdoc.org/pages/tags/label/) Added by the CommentPlugin during resolution.

overwrites?: ReferenceType

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

Applies to interface and class members.

parent?: Reflection

The reflection this reflection is a child of.

The contents of the readme file of the module when found.

relevanceBoost?: number

A precomputed boost derived from the searchCategoryBoosts and searchGroupBoosts options, used when boosting search relevance scores at runtime. May be modified by plugins.

setSignature?: SignatureReflection

The set signature of this declaration.

signatures?: SignatureReflection[]

A list of call signatures attached to this declaration.

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

sources?: SourceReference[]

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

type?: SomeType

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.

typeHierarchy?: DeclarationHierarchy

Contains a simplified representation of the type hierarchy suitable for being rendered in templates.

typeParameters?: TypeParameterReflection[]
url?: string

The url of this reflection in the generated documentation. TODO: Reflections shouldn't know urls exist. Move this to a serializer.

version?: string

The version of the module when found.

Accessors

Methods

  • Try to find a reflection by its name.

    Returns

    The found reflection or null.

    Deprecated

    This method not be used, it naively splits the name by a . and searches recursively up the parent tree, which is not how any other name resolver works. If you are currently using this and need another method, please open an issue. For tests getChildByName should generally be sufficient.

    Parameters

    • arg: string | string[]

    Returns undefined | Reflection

  • Return the full name of this reflection. Intended for use in debugging. For log messages intended to be displayed to the user for them to fix, prefer getFriendlyFullName instead.

    The full name contains the name of this reflection and the names of all parent reflections.

    Returns

    The full name of this reflection.

    Parameters

    • separator: string = "."

      Separator used to join the names of the reflections.

    Returns string

Generated using TypeDoc