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

Constructors

constructor

Properties

flags id kind name originalName anchor? categories? children? comment? cssClasses? defaultValue? escapedName? extendedBy? extendedTypes? getSignature? groups? hasOwnDocument? implementationOf? implementedBy? implementedTypes? indexSignature? inheritedFrom? kindString? label? overwrites? parent? readme? relevanceBoost? setSignature? signatures? sources? type? typeHierarchy? typeParameters? url? version?

Accessors

project

Methods

findReflectionByName getAlias getAllSignatures getChildByName getChildrenByKind getFriendlyFullName getFullName getNonIndexSignatures getTargetReflection getTargetReflectionDeep hasComment hasGetterOrSetter isDeprecated isProject kindOf setFlag toObject toString toStringHierarchy traverse tryGetTargetReflection tryGetTargetReflectionDeep

Constructors

constructor

Properties

flags

flags: 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.

originalName

originalName: string

The original name of the TypeScript declaration.

Optional anchor

anchor?: string

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

Optional categories

categories?: ReflectionCategory[]

All children grouped by their category.

Optional children

children?: DeclarationReflection[]

The children of this reflection.

Optional comment

comment?: Comment

The parsed documentation comment attached to this reflection.

Optional cssClasses

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.

Optional defaultValue

defaultValue?: string

The default value of this reflection.

Applies to function parameters, variables, and properties.

Optional Internal escapedName

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.

Optional extendedBy

extendedBy?: ReferenceType[]

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

Optional extendedTypes

extendedTypes?: SomeType[]

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

Optional getSignature

getSignature?: SignatureReflection

The get signature of this declaration.

Optional groups

groups?: ReflectionGroup[]

All children grouped by their kind.

Optional hasOwnDocument

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.

Optional implementationOf

implementationOf?: ReferenceType

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

Applies to class members.

Optional implementedBy

implementedBy?: ReferenceType[]

A list of all types that implement this reflection.

Optional implementedTypes

implementedTypes?: SomeType[]

A list of all types this reflection implements.

Optional indexSignature

indexSignature?: SignatureReflection

The index signature of this declaration.

Optional inheritedFrom

inheritedFrom?: ReferenceType

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

Applies to interface and class members.

Optional kindString

kindString?: string

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

Optional label

label?: string

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

Optional overwrites

overwrites?: ReferenceType

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

Applies to interface and class members.

Optional parent

parent?: Reflection

The reflection this reflection is a child of.

Optional readme

readme?: CommentDisplayPart[]

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

Optional relevanceBoost

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.

Optional setSignature

setSignature?: SignatureReflection

The set signature of this declaration.

Optional signatures

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.

Optional sources

sources?: SourceReference[]

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

Optional type

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.

Optional typeHierarchy

typeHierarchy?: DeclarationHierarchy

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

Optional typeParameters

typeParameters?: TypeParameterReflection[]

Optional url

url?: string

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

Optional version

version?: string

The version of the module when found.

Accessors

project

Methods

findReflectionByName

  • 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

getAlias

getAllSignatures

getChildByName

getChildrenByKind

getFriendlyFullName

getFullName

  • 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

getNonIndexSignatures

getTargetReflection

getTargetReflectionDeep

hasComment

hasGetterOrSetter

isDeprecated

isProject

kindOf

setFlag

toObject

toString

toStringHierarchy

traverse

tryGetTargetReflection

tryGetTargetReflectionDeep

Settings

Member Visibility

Theme

Generated using TypeDoc