Class ReferenceType

Represents a type that refers to another reflection like a class, interface or enum.

let value: MyClass<T>;

Hierarchy

Type
- ReferenceType

Index

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.

qualifiedName

qualifiedName: string

The fully qualified name of the referenced type, relative to the file it is defined in. This will usually be the same as name, unless namespaces are used.

`Readonly` type

type: "reference" = "reference"

The type name identifier.

`Optional` externalUrl

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.

`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` typeArguments

typeArguments?: SomeType[]

The type arguments of this reference.

Accessors

reflection

get reflection(): undefined | Reflection
The resolved reflection.

Returns undefined | Reflection
- Defined in src/lib/models/types.ts:776

Methods

getSymbol

getSymbol(): undefined | Symbol
Internal
Don't use this if at all possible. It will eventually go away since models may not retain information from the original TS objects to enable documentation generation from previously generated JSON.

Returns undefined | Symbol
- Defined in src/lib/models/types.ts:791

`Protected` getTypeString

getTypeString(): string
Implementation method for toString. needsParenthesis will be used to determine if the returned string should be wrapped in parenthesis.

Returns string
Overrides Type.getTypeString
- Defined in src/lib/models/types.ts:892

needsParenthesis

needsParenthesis(): boolean
Returns boolean
Overrides Type.needsParenthesis
- Defined in src/lib/models/types.ts:907

stringify

stringify(context: TypeContext): string
Parameters
- context: TypeContext
Returns string
Inherited from Type.stringify
- Defined in src/lib/models/types.ts:35

toDeclarationReference

toDeclarationReference(): DeclarationReference
Convert this reference type to a declaration reference used for resolution of external types.

Returns DeclarationReference
- Defined in src/lib/models/types.ts:801

toObject

toObject(serializer: Serializer): JSONOutput.ReferenceType
Parameters
- serializer: Serializer
Returns JSONOutput.ReferenceType
Overrides Type.toObject
- Defined in src/lib/models/types.ts:911

toString

toString(): string
Return a string representation of this type.

Returns string
Inherited from Type.toString
- Defined in src/lib/models/types.ts:22

visit

visit<T>(visitor: TypeVisitor<T>): T
Visit this type, returning the value returned by the visitor.
Type Parameters
- T
Parameters
- visitor: TypeVisitor<T>
Returns T
Inherited from Type.visit
- Defined in src/lib/models/types.ts:29
visit<T>(visitor: Partial<TypeVisitor<T>>): undefined | T
Type Parameters
- T
Parameters
- visitor: Partial<TypeVisitor<T>>
Returns undefined | T
Inherited from Type.visit
- Defined in src/lib/models/types.ts:30

`Static` createBrokenReference

createBrokenReference(name: string, project: ProjectReflection): ReferenceType
Internal
this is used for type parameters, which don't actually point to something
Parameters
- name: string
- project: ProjectReflection
Returns ReferenceType
- Defined in src/lib/models/types.ts:888

`Static` createResolvedReference

createResolvedReference(name: string, target: number | Reflection, project: ProjectReflection): ReferenceType
Parameters
- name: string
- target: number | Reflection
- project: ProjectReflection
Returns ReferenceType
- Defined in src/lib/models/types.ts:847

`Static` createSymbolReference

createSymbolReference(symbol: Symbol, context: Context, name?: string): ReferenceType
Parameters
- symbol: Symbol
- context: Context
- Optional name: string
Returns ReferenceType
- Defined in src/lib/models/types.ts:855

Class ReferenceType

Hierarchy

Index

Properties

Accessors

Methods

Properties

name

qualifiedName

Readonly type

Optional externalUrl

Optional package

Optional typeArguments

Accessors

reflection

Returns undefined | Reflection

Methods

getSymbol

Returns undefined | Symbol

Protected getTypeString

Returns string

needsParenthesis

Returns boolean

stringify

Parameters

context: TypeContext

Returns string

toDeclarationReference

Returns DeclarationReference

toObject

Parameters

serializer: Serializer

Returns JSONOutput.ReferenceType

toString

Returns string

visit

Type Parameters

T

Parameters

visitor: TypeVisitor<T>

Returns T

Type Parameters

T

Parameters

visitor: Partial<TypeVisitor<T>>

Returns undefined | T

Static createBrokenReference

Parameters

name: string

project: ProjectReflection

Returns ReferenceType

Static createResolvedReference

Parameters

name: string

target: number | Reflection

project: ProjectReflection

Returns ReferenceType

Static createSymbolReference

Parameters

symbol: Symbol

context: Context

Optional name: string

Returns ReferenceType

Settings

Member Visibility

Theme

`Readonly` type

`Optional` externalUrl

`Optional` package

`Optional` typeArguments

`Protected` getTypeString

`Static` createBrokenReference

`Static` createResolvedReference

`Static` createSymbolReference

`Optional` name: string