Interface ProjectReflection

interface ProjectReflection {
    flags: JSONOutput.ReflectionFlags;
    id: number;
    kind: ReflectionKind;
    name: string;
    symbolIdMap: Record<number, JSONOutput.ReflectionSymbolId>;
    variant: "project";
    categories?: JSONOutput.ReflectionCategory[];
    children?: JSONOutput.DeclarationReflection[];
    comment?: JSONOutput.Comment;
    groups?: JSONOutput.ReflectionGroup[];
    packageName?: string;
    packageVersion?: string;
    readme?: JSONOutput.CommentDisplayPart[];
}

Hierarchy

Properties

flags id kind name symbolIdMap variant categories? children? comment? groups? packageName? packageVersion? readme?

Properties

flags

flags: JSONOutput.ReflectionFlags

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.

symbolIdMap

symbolIdMap: Record<number, JSONOutput.ReflectionSymbolId>

Readonly variant

variant: "project" = "project"

Optional categories

categories?: JSONOutput.ReflectionCategory[]

All children grouped by their category.

Optional children

children?: JSONOutput.DeclarationReflection[]

The children of this reflection.

Optional comment

comment?: JSONOutput.Comment

The parsed documentation comment attached to this reflection.

Optional groups

groups?: JSONOutput.ReflectionGroup[]

All children grouped by their kind.

Optional packageName

packageName?: string

The name of the package that this reflection documents according to package.json.

Optional packageVersion

packageVersion?: string

The version of the package that this reflection documents according to package.json.

Optional readme

readme?: JSONOutput.CommentDisplayPart[]

The contents of the readme.md file of the project when found.

Settings

Member Visibility

Theme

On This Page

flagsidkindnamesymbolIdMapvariantcategorieschildrencommentgroupspackageNamepackageVersionreadme