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

    Interface DocumentReflection

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

    Hierarchy

    Index

    Properties

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

    Properties

    content

    content: JSONOutput.CommentDisplayPart[]

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

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

    Unique id of this reflection.

    kind: Models.ReflectionKind

    The kind of this reflection.

    name: string

    The symbol name of this reflection.

    variant: "document"

    Discriminator representing the type of reflection represented by this object.

    children?: JSONOutput.DocumentReflection[]

    Child documents, if any are present.

    comment?: JSONOutput.Comment

    The parsed documentation comment attached to 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.

    Settings

    Member Visibility

    On This Page

    Properties