Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

constructor

Properties

Private Optional _project

Private _target

_target: Symbol | Reflection

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

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 decorates

decorates: Type[]

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

Optional decorators

decorators: Decorator[]

A list of all decorators attached to this reflection.

Optional defaultValue

defaultValue: string

The default value of this reflection.

Applies to function parameters.

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

internal

Optional extendedBy

extendedBy: ReferenceType[]

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

Optional extendedTypes

extendedTypes: Type[]

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

flags

flags: ReflectionFlags = ...

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.

id

id: number

Unique id of this reflection.

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: Type[]

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.

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.

originalName

originalName: string

The original name of the TypeScript declaration.

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 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 ore or more signature reflections.

Optional sources

sources: SourceReference[]

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

Optional type

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

Accessors

isReference

  • get isReference(): boolean

Methods

Private _ensureProject

  • _ensureProject(): void

findReflectionByName

  • findReflectionByName(arg: string | string[]): undefined | Reflection

getAlias

  • getAlias(): string

getAllSignatures

getChildByName

  • getChildByName(arg: string | string[]): undefined | Reflection

getChildrenByKind

getFullName

  • getFullName(separator?: string): string
  • Return the full name of this reflection.

    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.

getTargetReflection

getTargetReflectionDeep

hasComment

  • hasComment(): boolean

hasGetterOrSetter

  • hasGetterOrSetter(): boolean

isProject

kindOf

setFlag

toString

  • toString(): string

toStringHierarchy

  • toStringHierarchy(indent?: string): string

traverse

  • traverse(callback: TraverseCallback): void
  • Traverse all potential child reflections of this reflection.

    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

  • tryGetTargetReflection(): undefined | Reflection

tryGetTargetReflectionDeep

  • tryGetTargetReflectionDeep(): undefined | Reflection

Generated using TypeDoc