Interface ReferenceType

interface ReferenceType {
    name: string;
    target: number | 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)

Properties

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

Properties

name

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

target: number | JSONOutput.ReflectionSymbolId

Readonlytype

type: "reference"

The type name identifier.

OptionalexternalUrl

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.

OptionalhighlightedProperties

highlightedProperties?: Record<string, JSONOutput.CommentDisplayPart[]>

Optionalpackage

package?: string

The package that this type is referencing.

OptionalpreferValues

preferValues?: boolean

OptionalqualifiedName

qualifiedName?: string

OptionalrefersToTypeParameter

refersToTypeParameter?: boolean

OptionaltypeArguments

typeArguments?: JSONOutput.SomeType[]

The type arguments of this reference.

Settings

Member Visibility

On This Page

Properties