API reference › @evolu/common › Array › sortArray

Call Signature

function sortArray<T>(
  array: readonly [T, T],
  compareFn?: (a: T, b: T) => number,
): readonly [T, T];

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

Returns a new sorted readonly array.

Wraps native toSorted. Preserves non-empty type.

Sorting without mutation

import {
  assertEqual,
  assertType,
  sortArray,
  type NonEmptyReadonlyArray,
} from "@evolu/common";

const values: NonEmptyReadonlyArray<number> = [3, 1, 2];
const sorted = sortArray(values, (a, b) => a - b);
assertEqual(sorted, [1, 2, 3]);
assertType<NonEmptyReadonlyArray<number>, typeof sorted>();

Call Signature

function sortArray<T>(
  array: readonly T[],
  compareFn?: (a: T, b: T) => number,
): readonly T[];

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

Possibly empty array.

Markdown for LLMs