Usage

const fish = [
  { name: "Marlin", weight: 105 },
  { name: "Bass", weight: 8 },
  { name: "Trout", weight: 13 },
];

sort(fish, (f) => f.weight); // => [Bass, Trout, Marlin]
sort(fish, (f) => f.weight, true); // => [Marlin, Trout, Bass]

Installation

CLI

npx atmx add helper sort

Manually

Copy and paste the following method into @/utils/helpers/sort.ts:

/**
* Sort an array without modifying it and return the newly sorted
* value.
*
* @example
* const fish = [
*   { name: 'Marlin', weight: 105 },
*   { name: 'Bass', weight: 8 },
*   { name: 'Trout', weight: 13 }
* ]
*
* sort(fish, f => f.weight) // => [Bass, Trout, Marlin]
* sort(fish, f => f.weight, true) // => [Marlin, Trout, Bass]
*/
export function sort<T>(
array: readonly T[],
getter: (item: T) => number,
desc = false,
): T[] {
if (!array) {
return [];
}
const asc = (a: T, b: T) => getter(a) - getter(b);
const dsc = (a: T, b: T) => getter(b) - getter(a);
return array.slice().sort(desc === true ? dsc : asc);
}