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

id: number

Unique id of this reflection.

The kind of this reflection.

name: string

The symbol name of this reflection.

symbolIdMap: Record<number, JSONOutput.ReflectionSymbolId>
variant: "project" = "project"

All children grouped by their category.

The children of this reflection.

The parsed documentation comment attached to this reflection.

All children grouped by their kind.

packageName?: string

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

packageVersion?: string

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

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

Generated using TypeDoc