KC's Workspace
    Preparing search index...

    Interface ProjectReflection

    interface ProjectReflection {
        categories?: ReflectionCategory[];
        children?: (ReferenceReflection | DeclarationReflection)[];
        childrenIncludingDocuments?: ReflectionId[];
        comment?: Comment;
        documents?: DocumentReflection[];
        files: FileRegistry;
        flags: ReflectionFlags;
        groups?: ReflectionGroup[];
        id: ReflectionId;
        kind: ReflectionKind;
        name: string;
        packageName?: string;
        packageVersion?: string;
        readme?: CommentDisplayPart[];
        schemaVersion: string;
        symbolIdMap: Record<ReflectionId, ReflectionSymbolId>;
        variant: "project";
    }

    Hierarchy (View Summary)

    Index

    Properties

    categories? children? childrenIncludingDocuments? comment? documents? files flags groups? id kind name packageName? packageVersion? readme? schemaVersion symbolIdMap variant

    Properties

    categories?: ReflectionCategory[]

    All children grouped by their category.

    children?: (ReferenceReflection | DeclarationReflection)[]

    The children of this reflection. Do not add reflections to this array manually. Instead call addChild.

    childrenIncludingDocuments?: ReflectionId[]
    comment?: Comment

    The parsed documentation comment attached to this reflection.

    documents?: DocumentReflection[]

    Documents associated with this reflection.

    These are not children as including them as children requires code handle both types, despite being mostly unrelated and handled separately.

    Including them here in a separate array neatly handles that problem, but also introduces another one for rendering. When rendering, documents should really actually be considered part of the "children" of a reflection. For this reason, we also maintain a list of child declarations with child documents which is used when rendering.

    files: FileRegistry
    flags: ReflectionFlags
    groups?: ReflectionGroup[]

    All children grouped by their kind.

    id: ReflectionId

    Unique id of this reflection.

    kind: ReflectionKind

    The kind of this reflection.

    name: string

    The symbol name of this reflection.

    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.

    readme?: CommentDisplayPart[]

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

    schemaVersion: string

    Used to determine if TypeDoc supports deserializing the specified json See SCHEMA_VERSION for the current version.

    symbolIdMap: Record<ReflectionId, ReflectionSymbolId>
    variant: "project"

    Discriminator representing the type of reflection represented by this object.

    Settings

    Member Visibility

    On This Page

    Properties