Function sortBy

Sorts an array of objects by a given property in ascending or descending order.

Remarks

This function does not mutate the input array.

Throws

If the input array is null, undefined, or empty.

Throws

If the specified property to sort by does not exist in one or more of the objects in the array.

Example

Sort by age in ascending order:

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

sortBy(users, 'age', 'asc')
// => { ok: true, value: [{ name: 'Bob', age: 20 }, { name: 'John', age: 25 }, { name: 'Alice', age: 30 }] }
Copy

Example

Sort by name in descending order:

sortBy(arr, 'name', 'desc')
// => { ok: true, value: [{ name: 'John', age: 25 }, { name: 'Bob', age: 20 }, { name: 'Alice', age: 30 }] }
Copy

Example

Sort by a nested property:

const arr2 = [
  { name: 'John', address: { city: 'New York', state: 'NY' } },
  { name: 'Alice', address: { city: 'Los Angeles', state: 'CA' } },
  { name: 'Bob', address: { city: 'San Francisco', state: 'CA' } }
];

sortBy(arr2, 'address.state', 'asc');
// => { ok: true, value: [{ name: 'Alice', address: { city: 'Los Angeles', state: 'CA' } }, { name: 'Bob', address: { city: 'San Francisco', state: 'CA' } }, { name: 'John', address: { city: 'New York', state: 'NY' } }] }
Copy