TypeDoc API - v0.28.7

    Interface ReferenceType

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

    Hierarchy (View Summary, Expand)

    Index

    Properties

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

    Properties

    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.

    target: Models.ReflectionId | JSONOutput.ReflectionSymbolId
    type: "reference"

    The type name identifier.

    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, JSONOutput.CommentDisplayPart[]>
    package?: string

    The package that this type is referencing.

    preferValues?: boolean
    qualifiedName?: string
    refersToTypeParameter?: boolean
    typeArguments?: JSONOutput.SomeType[]

    The type arguments of this reference.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR