CodeQL library for JavaScript/TypeScript
codeql/javascript-all 2.1.2-dev (changelog, source)
Search

Class TypeReference

A type that refers to a class, interface, enum, or enum member.

Import path

import javascript

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getADefinition

Gets a syntactic declaration of this named type.

getATypeArgument

Gets a type argument provided in this type.

getNumTypeArgument

Gets the number of type arguments provided in this type.

getTypeArgument

Gets the nth type argument provided in this type, such as string in Promise<string>.

getTypeName

Gets the canonical name of the type being referenced.

hasQualifiedName

Holds if the referenced type has the given qualified name, rooted in the global scope.

hasQualifiedName

Holds if the referenced type is exported from the given module under the given qualified name.

hasTypeArguments

Holds if type arguments are provided in this type.

Inherited predicates

getAConstructorSignature

Gets a constructor call signature.

from Type
getAFunctionSignature

Gets a function call signature.

from Type
getASignature

Gets a signature of the given kind.

from Type
getChild

Gets the ith child of this type.

from Type
getConstructorSignature

Gets the nth constructor call signature.

from Type
getFunctionSignature

Gets the nth function call signature.

from Type
getKind

Gets the kind of this type, which is an integer value denoting how the type is stored in the database.

from Type
getLastConstructorSignature

Gets the last constructor call signature.

from Type
getLastFunctionSignature

Gets the last function call signature.

from Type
getLastSignature

Gets the last signature of the given kind.

from Type
getNumConstructorSignature

Gets the number of constructor call signatures.

from Type
getNumFunctionSignature

Gets the number of function call signatures.

from Type
getNumSignature

Gets the number of signatures of the given kind.

from Type
getNumberIndexType

Gets the type of the number index signature on this type, such as T in the type { [n: number]: T }.

from Type
getSignature

Gets the nth signature of the given kind present on this type.

from Type
getStringIndexType

Gets the type of the string index signature on this type, such as T in the type { [s: string]: T }.

from Type
hasUnderlyingType

Holds if this refers to the given named type, or is declared as a subtype thereof, or is a union or intersection containing such a type.

from Type
hasUnderlyingType

Holds if this refers to the given named type, or is declared as a subtype thereof, or is a union or intersection containing such a type.

from Type
hasUnderlyingTypeName

Holds if this refers to the given named type, or is declared as a subtype thereof, or is a union or intersection containing such a type.

from Type
toString

Gets a string representation of this type.

from Type
unfold

Repeatedly unfolds unions, intersections, and type aliases and gets any of the underlying types, or this type itself if it is not a union or intersection.

from Type
unfoldUnionAndIntersection

Repeatedly unfolds union and intersection types and gets any of the underlying types, or this type itself if it is not a union or intersection.

from Type