Skip to main content

Function: isArray()

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

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

Determines whether a value is an array and optionally validates each element.

Type Parameters​

T​

T = unknown

Element type enforced by the optional validator.

Parameters​

value​

unknown

Value to evaluate.

itemValidator?​

(item: unknown) => item is T

Optional guard applied to each array element.

Returns​

value is T[]

true when the value is an array and all elements pass the guard.

Example​

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