Function isArray

isArray<E>(value: E): value is FilterArray<E>

Type guard that checks if a value is an array.

Type Parameters

E

Parameters

value: E

Returns value is FilterArray<E>

Example

const maybeArray: unknown = [1, 2, 3];

const maybeValue: unknown = 'Ada';

assert.isTrue(Arr.isArray(maybeArray));

assert.isFalse(Arr.isArray(maybeValue));

if (Arr.isArray(maybeArray)) {
  assert.deepStrictEqual(maybeArray, [1, 2, 3]);
}