clean-jsdoc-theme TypeDoc APIv0.0.0

sortBy

sortBy< T, >( array: T[], comparators: ((a: T, b: T) => number)[], ): T[]

Source: array.ts:296

Sorts an array by multiple criteria

Type Parameters

  • T — Array element type

Parameters

  • array (T[]) — The input array
  • comparators (((a: T, b: T) => number)[]) — Array of comparator functions

Returns

  • T[] — New sorted array

Example

CODE
const users = [
  { name: 'Bob', age: 30 },
  { name: 'Alice', age: 25 },
  { name: 'Alice', age: 30 }
]

sortBy(users, [
  (a, b) => a.name.localeCompare(b.name),
  (a, b) => a.age - b.age
])
// [{ name: 'Alice', age: 25 }, { name: 'Alice', age: 30 }, { name: 'Bob', age: 30 }]