Interface ContainerReflection

interface ContainerReflection {
    flags: JSONOutput.ReflectionFlags;
    id: number;
    kind: ReflectionKind;
    name: string;
    variant: keyof ReflectionVariant;
    categories?: JSONOutput.ReflectionCategory[];
    children?: JSONOutput.DeclarationReflection[];
    comment?: JSONOutput.Comment;
    groups?: JSONOutput.ReflectionGroup[];
}

Hierarchy (view full)

JSONOutput.Reflection
S<Models.ContainerReflection, "children" | "groups" | "categories">
- ContainerReflection

Index

Properties

flags id kind name variant categories? children? comment? groups?

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.

`Readonly` `Abstract` variant

variant: keyof ReflectionVariant

Discriminator representing the type of reflection represented by this object.

`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.