KC's Workspace
    Preparing search index...
    interface ContainerReflection {
        categories?: ReflectionCategory[];
        children?: (ReferenceReflection | DeclarationReflection)[];
        childrenIncludingDocuments?: ReflectionId[];
        comment?: Comment;
        documents?: DocumentReflection[];
        flags: ReflectionFlags;
        groups?: ReflectionGroup[];
        id: ReflectionId;
        kind: ReflectionKind;
        name: string;
        variant: keyof ReflectionVariant;
    }

    Hierarchy (View Summary)

    Index

    Properties

    categories?: ReflectionCategory[]

    All children grouped by their category.

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

    childrenIncludingDocuments?: ReflectionId[]
    comment?: Comment

    The parsed documentation comment attached to this reflection.

    documents?: 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.

    groups?: ReflectionGroup[]

    All children grouped by their kind.

    Unique id of this reflection.

    The kind of this reflection.

    name: string

    The symbol name of this reflection.

    variant: keyof ReflectionVariant

    Discriminator representing the type of reflection represented by this object.