Class ReferenceReflection

Describes a reflection which does not exist at this location, but is referenced. Used for imported reflections.

// a.ts
export const a = 1;
// b.ts
import { a } from './a';
// Here to avoid extra work we create a reference to the original reflection in module a instead
// of copying the reflection.
export { a };

Hierarchy (view full)

Constructors

constructor

Properties

flags id kind name project variant anchor? categories? children? childrenIncludingDocuments? comment? defaultValue? documents? escapedName? extendedBy? extendedTypes? getSignature? groups? hasOwnDocument? implementationOf? implementedBy? implementedTypes? indexSignatures? inheritedFrom? overwrites? packageVersion? parent? readme? relevanceBoost? setSignature? signatures? sources? type? typeHierarchy? typeParameters? url?

Methods

addChild fromObject getAlias getAllSignatures getChildByName getChildrenByKind getFriendlyFullName getFullName getNonIndexSignatures getTargetReflection getTargetReflectionDeep getUniqueAliasInPage hasComment hasGetterOrSetter isDeclaration isDeprecated isDocument isProject kindOf removeChild setFlag toObject toString toStringHierarchy traverse tryGetTargetReflection tryGetTargetReflectionDeep visit

Constructors

constructor

Properties

flags

flags: Models.ReflectionFlags = ...

id

id: number

Unique id of this reflection.

kind

kind: ReflectionKind

The kind of this reflection.

name

name: string

The symbol name of this reflection.

project

project: Models.ProjectReflection

Readonlyvariant

variant: "reference" = "reference"

Discriminator representing the type of reflection represented by this object.

Optionalanchor

anchor?: string

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

Optionalcategories

categories?: Models.ReflectionCategory[]

All children grouped by their category.

Optionalchildren

children?: Models.DeclarationReflection[]

The children of this reflection. Do not add reflections to this array manually. Instead call addChild.

OptionalchildrenIncludingDocuments

childrenIncludingDocuments?: (Models.DeclarationReflection | Models.DocumentReflection)[]

Union of the children and documents arrays which dictates the sort order for rendering.

Optionalcomment

comment?: Models.Comment

The parsed documentation comment attached to this reflection.

OptionaldefaultValue

defaultValue?: string

The default value of this reflection.

Applies to function parameters, variables, and properties.

Optionaldocuments

documents?: Models.DocumentReflection[]

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

Optional InternalescapedName

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.

Not serialized, only useful during conversion.

OptionalextendedBy

extendedBy?: Models.ReferenceType[]

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

OptionalextendedTypes

extendedTypes?: Models.SomeType[]

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

OptionalgetSignature

getSignature?: Models.SignatureReflection

The get signature of this declaration.

Optionalgroups

groups?: Models.ReflectionGroup[]

All children grouped by their kind.

OptionalhasOwnDocument

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.

OptionalimplementationOf

implementationOf?: Models.ReferenceType

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

Applies to class members.

OptionalimplementedBy

implementedBy?: Models.ReferenceType[]

A list of all types that implement this reflection.

OptionalimplementedTypes

implementedTypes?: Models.SomeType[]

A list of all types this reflection implements.

OptionalindexSignatures

indexSignatures?: Models.SignatureReflection[]

The index signature of this declaration.

OptionalinheritedFrom

inheritedFrom?: Models.ReferenceType

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

Applies to interface and class members.

Optionaloverwrites

overwrites?: Models.ReferenceType

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

Applies to interface and class members.

OptionalpackageVersion

packageVersion?: string

The version of the module when found.

Optionalparent

parent?: Models.Reflection

The reflection this reflection is a child of.

Optionalreadme

readme?: Models.CommentDisplayPart[]

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

OptionalrelevanceBoost

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.

OptionalsetSignature

setSignature?: Models.SignatureReflection

The set signature of this declaration.

Optionalsignatures

signatures?: Models.SignatureReflection[]

A list of call signatures attached to this declaration.

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

Optionalsources

sources?: Models.SourceReference[]

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

Optionaltype

type?: Models.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.

OptionaltypeHierarchy

typeHierarchy?: DeclarationHierarchy

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

OptionaltypeParameters

typeParameters?: Models.TypeParameterReflection[]

Optionalurl

url?: string

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

Methods

addChild

fromObject

getAlias

getAllSignatures

getChildByName

getChildrenByKind

getFriendlyFullName

getFullName

  • getFullName(separator?): string

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

    Parameters

    • separator: string = "."

      Separator used to join the names of the reflections.

    Returns string

    The full name of this reflection.

getNonIndexSignatures

getTargetReflection

getTargetReflectionDeep

getUniqueAliasInPage

hasComment

hasGetterOrSetter

isDeclaration

isDeprecated

isDocument

isProject

kindOf

removeChild

setFlag

toObject

toString

toStringHierarchy

  • toStringHierarchy(indent?): string

  • Return a string representation of this reflection and all of its children.

    Note: This is intended as a debug tool only, output may change between patch versions.

    Parameters

    • indent: string = ""

      Used internally to indent child reflections.

    Returns string

traverse

  • traverse(callback): void

  • Traverse most potential child reflections of this reflection.

    Note: This may not necessarily traverse child reflections contained within the type property of the reflection, and should not be relied on for this. Support for checking object types will likely be removed in v0.27.

    The given callback will be invoked for all children, signatures and type parameters attached to this reflection.

    Parameters

    • callback: TraverseCallback

      The callback function that should be applied for each child reflection.

    Returns void

tryGetTargetReflection

tryGetTargetReflectionDeep

visit

Settings

Member Visibility

On This Page

Constructors
Properties
Methods