Interface ReferenceType

Hierarchy

JSONOutput.Type
S<ReferenceType, "type" | "name" | "typeArguments" | "package">
- ReferenceType

Index

Properties

name type id? package? qualifiedName? typeArguments?

Properties

name

name: string

The name of the referenced type.

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

`Readonly` type

type: "reference" = "reference"

`Optional` id

id?: number

`Optional` package

package?: string

The package that this type is referencing. Will only be set for ReferenceTypes pointing to a symbol within node_modules.

`Optional` qualifiedName

qualifiedName?: string

`Optional` typeArguments

The type arguments of this reference.

Generated using TypeDoc