Interface DocumentReflection

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

Hierarchy

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

flags: JSONOutput.ReflectionFlags

frontmatter

frontmatter: Record<string, unknown>

id

id: number

Unique id of this reflection.

kind

kind: ReflectionKind

The kind of this reflection.

name

name: string

The symbol name of this reflection.

Readonlyvariant

variant: "document" = "document"

Discriminator representing the type of reflection represented by this object.

Optionalchildren

children?: JSONOutput.DocumentReflection[]

Child documents, if any are present.

Optionalcomment

comment?: JSONOutput.Comment

The parsed documentation comment attached to this reflection.

OptionalrelevanceBoost

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