API reference / @evolu/common / Array / isNonEmptyReadonlyArray

Function: isNonEmptyReadonlyArray()

function isNonEmptyReadonlyArray<T>(array): array is readonly [T, T];

Defined in: packages/common/src/Array.ts:138

Checks if a readonly array is non-empty and narrows its type to NonEmptyReadonlyArray.

Use if (!isNonEmptyReadonlyArray(arr)) for empty checks.

Example

const arr: ReadonlyArray<number> = [1, 2, 3];
if (isNonEmptyReadonlyArray(arr)) {
  firstInArray(arr); // arr is NonEmptyReadonlyArray<number>
}

Type Parameters

Type Parameter
T

Parameters

ParameterType
arrayreadonly T[]

Returns

array is readonly [T, T]

Was this page helpful?