API reference@evolu/commonArray › concatArrays

Call Signature

function concatArrays<T>(
  first: readonly [T, T],
  second: readonly T[],
): readonly [T, T];

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

Concatenates two arrays, returning a new readonly array.

Returns a non-empty array when at least one input is non-empty.

Concatenating non-empty inputs

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

const nonEmpty: NonEmptyReadonlyArray<number> = [1];
const joined = concatArrays([1, 2], [3, 4]);
const fromLeft = concatArrays(nonEmpty, []);
const fromRight = concatArrays([], nonEmpty);

expect(joined).toEqual([1, 2, 3, 4]);
expectTypeOf(fromLeft).toEqualTypeOf<NonEmptyReadonlyArray<number>>();
expectTypeOf(fromRight).toEqualTypeOf<NonEmptyReadonlyArray<number>>();

Call Signature

function concatArrays<T>(
  first: readonly T[],
  second: readonly [T, T],
): readonly [T, T];

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

Second non-empty.

Call Signature

function concatArrays<T>(
  first: readonly T[],
  second: readonly T[],
): readonly T[];

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

Both possibly empty.