Skip to main content

Function: isArray()

isArray<T>(value: unknown, itemValidator?: (item: unknown) => item is T): value is T[]

Defined in: shared/utils/typeGuards.ts:113

Determines if a value is an array, optionally validating each item.

Type Parameters​

T​

T = unknown

The type of array items, inferred by the optional validator.

Parameters​

value​

unknown

The value to check.

itemValidator?​

(item: unknown) => item is T

Optional type guard to validate each item in the array.

Returns​

value is T[]

True if value is an array (and all items pass itemValidator, if provided); otherwise, false.

Example​

if (isArray(arr, isString)) {
    // arr is string[]
}