KC's Workspace
    Preparing search index...

    Interface DocumentReflection

    interface DocumentReflection {
        children?: DocumentReflection[];
        comment?: Comment;
        content: CommentDisplayPart[];
        flags: ReflectionFlags;
        frontmatter: Record<string, unknown>;
        id: ReflectionId;
        kind: ReflectionKind;
        name: string;
        relevanceBoost?: number;
        variant: "document";
    }

    Hierarchy (View Summary)

    Index

    Properties

    children? comment? content flags frontmatter id kind name relevanceBoost? variant

    Properties

    children?: DocumentReflection[]

    Child documents, if any are present.

    comment?: Comment

    The parsed documentation comment attached to this reflection.

    content

    content: CommentDisplayPart[]

    The content to be displayed on the page for this reflection.

    flags: ReflectionFlags
    frontmatter: Record<string, unknown>
    id: ReflectionId

    Unique id of this reflection.

    kind: ReflectionKind

    The kind of this reflection.

    name: string

    The symbol name of this reflection.

    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.

    variant: "document"

    Discriminator representing the type of reflection represented by this object.

    Settings

    Member Visibility

    On This Page

    Properties