orderBy (Functional Programming)

Creates a function that sorts objects by criteria and sort orders. Use it with pipe.

const result = pipe(array, orderBy(criteria, orders));

INFO

Prefer the original es-toolkit orderBy in ordinary code. Use this fp variant when composing transformations with pipe.

Usage

orderBy sorts the piped array by each criterion in order. Each order controls whether the matching criterion is sorted ascending or descending.

import { orderBy, pipe } from 'es-toolkit/fp';

const users = [
  { name: 'a', age: 2 },
  { name: 'b', age: 1 },
];

pipe(users, orderBy(['age'], ['asc'])); // => [{ name: 'b', age: 1 }, { name: 'a', age: 2 }]

Parameters

• criteria (Array<((item: T) => unknown) | keyof T>): The object keys and/or selector functions used for comparison.
• orders (Array<'asc' | 'desc'>): The sort order for each criterion.

Returns

((array: readonly T[]) => T[]): A function that maps a readonly T[] to a new, sorted array.