KC's Workspace
    Preparing search index...

    Interface ReferenceType

    interface ReferenceType {
        externalUrl?: string;
        highlightedProperties?: Record<string, CommentDisplayPart[]>;
        name: string;
        package?: string;
        preferValues?: boolean;
        qualifiedName?: string;
        refersToTypeParameter?: boolean;
        target: ReflectionId | ReflectionSymbolId;
        type: "reference";
        typeArguments?: SomeType[];
    }

    Hierarchy (View Summary)

    • Type
    • S<ReferenceType, "type" | "name" | "typeArguments" | "package" | "externalUrl">
      • ReferenceType
    Index

    Properties

    externalUrl? highlightedProperties? name package? preferValues? qualifiedName? refersToTypeParameter? target type typeArguments?

    Properties

    externalUrl?: string

    If this reference type refers to a reflection defined by a project not being rendered, points to the url that this type should be linked to.

    highlightedProperties?: Record<string, CommentDisplayPart[]>
    name: string

    The name of the referenced type.

    If the symbol cannot be found because it's not part of the documentation this can be used to represent the type.

    package?: string

    The package that this type is referencing.

    preferValues?: boolean
    qualifiedName?: string
    refersToTypeParameter?: boolean
    target: ReflectionId | ReflectionSymbolId
    type: "reference"

    The type name identifier.

    typeArguments?: SomeType[]

    The type arguments of this reference.

    Settings

    Member Visibility

    On This Page

    Properties