TypeDoc API - v0.28.14
    Preparing search index...

    Interface ReferenceReflection

    interface ReferenceReflection {
        flags: JSONOutput.ReflectionFlags;
        id: Models.ReflectionId;
        kind: Models.ReflectionKind;
        name: string;
        target: Models.ReflectionId;
        variant: "reference";
        categories?: JSONOutput.ReflectionCategory[];
        children?: (
            JSONOutput.DeclarationReflection
            | JSONOutput.ReferenceReflection
        )[];
        childrenIncludingDocuments?: Models.ReflectionId[];
        comment?: JSONOutput.Comment;
        defaultValue?: string;
        documents?: JSONOutput.DocumentReflection[];
        extendedBy?: JSONOutput.ReferenceType[];
        extendedTypes?: JSONOutput.SomeType[];
        getSignature?: JSONOutput.SignatureReflection;
        groups?: JSONOutput.ReflectionGroup[];
        implementationOf?: JSONOutput.ReferenceType;
        implementedBy?: JSONOutput.ReferenceType[];
        implementedTypes?: JSONOutput.SomeType[];
        indexSignatures?: JSONOutput.SignatureReflection[];
        inheritedFrom?: JSONOutput.ReferenceType;
        overwrites?: JSONOutput.ReferenceType;
        packageVersion?: string;
        readme?: JSONOutput.CommentDisplayPart[];
        setSignature?: JSONOutput.SignatureReflection;
        signatures?: JSONOutput.SignatureReflection[];
        sources?: JSONOutput.SourceReference[];
        type?:
            | JSONOutput.ReferenceType
            | JSONOutput.ArrayType
            | JSONOutput.ConditionalType
            | JSONOutput.IndexedAccessType
            | JSONOutput.InferredType
            | JSONOutput.IntersectionType
            | JSONOutput.IntrinsicType
            | JSONOutput.LiteralType
            | JSONOutput.MappedType
            | JSONOutput.OptionalType
            | JSONOutput.PredicateType
            | JSONOutput.QueryType
            | JSONOutput.ReflectionType
            | JSONOutput.RestType
            | JSONOutput.TemplateLiteralType
            | JSONOutput.TupleType
            | NamedTupleMemberType
            | JSONOutput.TypeOperatorType
            | JSONOutput.UnionType
            | JSONOutput.UnknownType;
        typeParameters?: JSONOutput.TypeParameterReflection[];
    }

    Hierarchy

    Index

    Properties

    flags id kind name target variant categories? children? childrenIncludingDocuments? comment? defaultValue? documents? extendedBy? extendedTypes? getSignature? groups? implementationOf? implementedBy? implementedTypes? indexSignatures? inheritedFrom? overwrites? packageVersion? readme? setSignature? signatures? sources? type? typeParameters?

    Properties

    flags: JSONOutput.ReflectionFlags
    id: Models.ReflectionId

    Unique id of this reflection.

    kind: Models.ReflectionKind

    The kind of this reflection.

    name: string

    The symbol name of this reflection.

    target: Models.ReflectionId

    -1 if the reference refers to a symbol that does not exist in the documentation. Otherwise, the reflection ID.

    variant: "reference"
    categories?: JSONOutput.ReflectionCategory[]

    All children grouped by their category.

    children?: (JSONOutput.DeclarationReflection | JSONOutput.ReferenceReflection)[]

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

    childrenIncludingDocuments?: Models.ReflectionId[]
    comment?: JSONOutput.Comment

    The parsed documentation comment attached to this reflection.

    defaultValue?: string

    The default value of this reflection.

    Applies to function parameters, variables, and properties.

    documents?: JSONOutput.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.

    extendedBy?: JSONOutput.ReferenceType[]

    A list of all types that extend this reflection (e.g. the subclasses).

    extendedTypes?: JSONOutput.SomeType[]

    A list of all types this reflection extends (e.g. the parent classes).

    getSignature?: JSONOutput.SignatureReflection

    The get signature of this declaration.

    groups?: JSONOutput.ReflectionGroup[]

    All children grouped by their kind.

    implementationOf?: JSONOutput.ReferenceType

    A type that points to the reflection this reflection is the implementation of.

    Applies to class members.

    implementedBy?: JSONOutput.ReferenceType[]

    A list of all types that implement this reflection.

    implementedTypes?: JSONOutput.SomeType[]

    A list of all types this reflection implements.

    indexSignatures?: JSONOutput.SignatureReflection[]

    The index signature of this declaration.

    inheritedFrom?: JSONOutput.ReferenceType

    A type that points to the reflection this reflection has been inherited from.

    Applies to interface and class members.

    overwrites?: JSONOutput.ReferenceType

    A type that points to the reflection that has been overwritten by this reflection.

    Applies to interface and class members.

    packageVersion?: string

    The version of the module when found.

    readme?: JSONOutput.CommentDisplayPart[]

    The contents of the readme file of the module when found.

    setSignature?: JSONOutput.SignatureReflection

    The set signature of this declaration.

    signatures?: JSONOutput.SignatureReflection[]

    A list of call signatures attached to this declaration.

    TypeDoc creates one declaration per function that may contain one or more signature reflections.

    sources?: JSONOutput.SourceReference[]

    A list of all source files that contributed to this reflection.

    type?:
        | JSONOutput.ReferenceType
        | JSONOutput.ArrayType
        | JSONOutput.ConditionalType
        | JSONOutput.IndexedAccessType
        | JSONOutput.InferredType
        | JSONOutput.IntersectionType
        | JSONOutput.IntrinsicType
        | JSONOutput.LiteralType
        | JSONOutput.MappedType
        | JSONOutput.OptionalType
        | JSONOutput.PredicateType
        | JSONOutput.QueryType
        | JSONOutput.ReflectionType
        | JSONOutput.RestType
        | JSONOutput.TemplateLiteralType
        | JSONOutput.TupleType
        | NamedTupleMemberType
        | JSONOutput.TypeOperatorType
        | JSONOutput.UnionType
        | JSONOutput.UnknownType

    The type of the reflection.

    If the reflection represents a variable or a property, this is the value type.
    If the reflection represents a signature, this is the return type.

    typeParameters?: JSONOutput.TypeParameterReflection[]

    Settings

    Member Visibility

    On This Page

    Properties