TypeDoc API - v0.28.2

    Class ContainerReflectionAbstract

    Hierarchy (View Summary, Expand)

    Index

    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.

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

    Unique id of this reflection.

    The kind of this reflection.

    name: string

    The symbol name of this reflection.

    variant: keyof Models.ReflectionVariant

    Discriminator representing the type of reflection represented by this object.

    categories?: Models.ReflectionCategory[]

    All children grouped by their category.

    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.

    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.

    All children grouped by their kind.

    The reflection this reflection is a child of.

    MMNEPVFCICPMFPCPTTAAATR