prependToArray - API reference

API reference › @evolu/common › Array › prependToArray

function prependToArray<T>(array: readonly T[], item: T): readonly [T, T];

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

Prepends an item to an array, returning a new non-empty readonly array.

Prepending a value

import { prependToArray, type NonEmptyReadonlyArray } from "@evolu/common";

const values = prependToArray([2, 3], 1);
expect(values).toEqual([1, 2, 3]);
expectTypeOf(values).toEqualTypeOf<NonEmptyReadonlyArray<number>>();