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

let value: MyClass<T>;

Hierarchy

Properties

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.

package?: string

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

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. Will only be set for ReferenceTypes pointing to a symbol within node_modules.

type: "reference" = "reference"

The type name identifier.

typeArguments?: SomeType[]

The type arguments of this reference.

Accessors

  • The resolved reflection.

    Returns undefined | Reflection

Methods

  • 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

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

    Returns string

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

    Returns string

  • Visit this type, returning the value returned by the visitor.

    Type Parameters

    • T

    Parameters

    Returns T

  • Type Parameters

    • T

    Parameters

    Returns undefined | T

  • Internal

    this is used for type parameters, which don't actually point to something

    Parameters

    Returns ReferenceType

Generated using TypeDoc