Function isArrayAtMostLength

isArrayAtMostLength<E, N extends ArgArr>(
array: readonly E[],
len: N,
): array is ArrayAtMostLen<N, E>

Checks if an array has at most a specific length.

Type Parameters

E
N extends ArgArr

Parameters

array: readonly E[]
len: N

Returns array is ArrayAtMostLen<N, E>

Example

const pair: readonly number[] = [1, 2] as const;

const triple: readonly number[] = [1, 2, 3] as const;

assert.isTrue(Arr.isArrayAtMostLength(pair, 2));

assert.isFalse(Arr.isArrayAtMostLength(triple, 2));

if (Arr.isArrayAtMostLength(pair, 2)) {
  assert.isTrue(pair.length <= 2);
}