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

Class ArrayType

A type that describes a JavaScript Array object.

Specifically, the following three kinds of types are considered array types:

  • Plain arrays such as Array<string>, or equivalently, string[],
  • Read-only arrays such as ReadonlyArray<string>,
  • Tuple types such as [string, number, number].

Foreign array-like objects such as HTMLCollection are not normal JavaScript arrays, and their corresponding types are not considered array types either.

Import path

import javascript

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getArrayElementType

Gets the type of element in the 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

Charpred