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.
Optional
packageThe package that this type is referencing.
Will only be set for ReferenceType
s pointing to a symbol within node_modules
.
Optional
qualifiedThe 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 ReferenceType
s pointing to a symbol within node_modules
.
Readonly
typeThe type name identifier.
Optional
typeThe type arguments of this reference.
The resolved reflection.
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.
Protected
getImplementation method for toString
. needsParenthesis
will be used to determine if
the returned string should be wrapped in parenthesis.
Return a string representation of this type.
Visit this type, returning the value returned by the visitor.
Static
createInternal
this is used for type parameters, which don't actually point to something
Static
createStatic
createOptional
name: stringGenerated using TypeDoc
Represents a type that refers to another reflection like a class, interface or enum.