KC's Workspace
    Preparing search index...

    Class ReferenceType

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

    let value: MyClass<T>;

    Hierarchy (View Summary)

    Index

    Properties

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

    Accessors

    reflection symbolId

    Methods

    estimatePrintWidth fromObject getTypeString isIntentionallyBroken needsParenthesis stringify toDeclarationReference toObject toString visit createBrokenReference createResolvedReference createUnresolvedReference

    Properties

    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?: Map<string, CommentDisplayPart[]>

    Sometimes a few properties are more important than the rest of the properties within a type. This occurs most often with object parameters, where users want to specify @param foo.bar to highlight something about the bar property.

    Does NOT support nested 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.

    package?: string

    The package that this type is referencing.

    preferValues: boolean

    If set, will prefer reflections with ReflectionKinds which represent values rather than those which represent types.

    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.

    refersToTypeParameter: boolean

    If set, no warnings about something not being exported should be created since this may be referring to a type created with infer X which will not be registered on the project.

    type: "reference"

    The type name identifier.

    typeArguments?: SomeType[]

    The type arguments of this reference.

    Accessors

    • get reflection(): Reflection | undefined

      The resolved reflection.

      Returns Reflection | undefined

    • get symbolId(): ReflectionSymbolId | undefined

      If not resolved, the symbol id of the reflection, otherwise undefined.

      Returns ReflectionSymbolId | undefined

    Methods

    • Return the estimated size of the type if it was all printed on one line.

      Returns number

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

      Returns string

    • Checks if this type is a reference type because it uses a name, but is intentionally not pointing to a reflection. This happens for type parameters and when representing a mapped type.

      Returns boolean

    • Returns boolean

    • Parameters

      Returns string

    • Convert this reference type to a declaration reference used for resolution of external types.

      Returns DeclarationReference

    • Return a string representation of this type.

      Returns string

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

      Type Parameters

      • T
      • A extends any[] = []

      Parameters

      Returns T

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

      Type Parameters

      • T
      • A extends any[] = []

      Parameters

      Returns T | undefined

    • Internal

      This is used for type parameters, which don't actually point to something, and also for temporary references which will be cleaned up with real references later during conversion.

      Parameters

      Returns ReferenceType

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods