TypeDoc API - v0.28.14
    Preparing search index...

    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 Summary)

    Index

    Constructors

    constructor

    Methods

    addChild fromObject getAllSignatures getChildByName getChildOrTypePropertyByName getChildrenByKind getFriendlyFullName getFullName getNonIndexSignatures getProperties getTargetReflection getTargetReflectionDeep hasComment hasGetterOrSetter isContainer isDeclaration isDeprecated isDocument isParameter isProject isReference isSignature isTypeParameter kindOf removeChild setFlag toObject toString toStringHierarchy traverse tryGetTargetReflection tryGetTargetReflectionDeep visit

    Properties

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

    Constructors

    Methods

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

    • Checks if this reflection has a comment which contains any visible text.

      Parameters

      • OptionalnotRenderedTags: readonly `@${string}`[]

      Returns boolean

      TRUE when this reflection has a visible comment.

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

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

      Parameters

      Returns void

    Properties

    flags: Models.ReflectionFlags = ...
    id: Models.ReflectionId

    Unique id of this reflection.

    kind: Models.ReflectionKind

    The kind of this reflection.

    name: string

    The symbol name of this reflection.

    project: Models.ProjectReflection
    variant: "reference"

    Discriminator representing the type of reflection represented by this object.

    categories?: Models.ReflectionCategory[]

    All children grouped by their category.

    children?: Models.DeclarationReflection[]

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

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

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

    comment?: Models.Comment

    The parsed documentation comment attached to this reflection.

    defaultValue?: string

    The default value of this reflection.

    Applies to function parameters, variables, and properties.

    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.

    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. This is a ts.__String.

    extendedBy?: Models.ReferenceType[]

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

    extendedTypes?: Models.SomeType[]

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

    getSignature?: Models.SignatureReflection

    The get signature of this declaration.

    groups?: Models.ReflectionGroup[]

    All children grouped by their kind.

    implementationOf?: Models.ReferenceType

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

    Applies to class members.

    implementedBy?: Models.ReferenceType[]

    A list of all types that implement this reflection.

    implementedTypes?: Models.SomeType[]

    A list of all types this reflection implements.

    indexSignatures?: Models.SignatureReflection[]

    The index signature of this declaration.

    inheritedFrom?: Models.ReferenceType

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

    Applies to interface and class members.

    overwrites?: Models.ReferenceType

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

    Applies to interface and class members.

    packageVersion?: string

    The version of the module when found.

    parent?: Models.Reflection

    The reflection this reflection is a child of.

    readme?: Models.CommentDisplayPart[]

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

    setSignature?: Models.SignatureReflection

    The set signature of this declaration.

    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.

    sources?: Models.SourceReference[]

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

    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.

    typeHierarchy?: Models.DeclarationHierarchy

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

    typeParameters?: Models.TypeParameterReflection[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties