Skip to content

@technobuddha > library > Object > Type Guards

Function: isArrayLike()

ts
function isArrayLike(value: unknown): value is ArrayLike<unknown>;

Defined in: is-array-like.ts:45

Determines whether the provided value is array-like.

A value is considered array-like if it is not null or undefined, is object-like, is not a function, has a 'length' property, and the length is a valid array length.

Parameters

ParameterTypeDescription
valueunknownThe value to check.

Returns

value is ArrayLike<unknown>

True if the value is array-like, otherwise false.

Example

typescript
isArrayLike([1, 2, 3]); // true
isArrayLike('hello'); // true
isArrayLike({ length: 2 }); // true
isArrayLike({}); // false
isArrayLike(() => {}); // false
isArrayLike(null); // false