Skip to main content

Function: isArrayLikeType()

isArrayLikeType(checker: Readonly<ts.TypeChecker>, type: Readonly<ts.Type>, unionMatchMode?: UnionArrayLikeMatchMode): boolean

Defined in: _internal/array-like-expression.ts:203

Determine whether a TypeScript type resolves to an array-like shape.

Parametersโ€‹

checkerโ€‹

Readonly<ts.TypeChecker>

Type checker used to inspect and unwrap candidate types.

typeโ€‹

Readonly<ts.Type>

Candidate type to evaluate.

unionMatchMode?โ€‹

UnionArrayLikeMatchMode = "some"

Strategy for union members ("some" or "every").

Returnsโ€‹

boolean

true when the candidate resolves to an array/tuple-like type.