Usage

alphabetical(["foo", "bar", "baz"], (item) => item); // ["bar", "baz", "foo"]

Installation

CLI

npx atmx add helper alphabetical

Manually

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

/**
* Sorts an array of string in alphabetical order
*
* @param array - The array to sort
*
* @example alphabetical(["foo", "bar", "baz"], (item) => item); // ["bar", "baz", "foo"]
*/
export function alphabetical<T>(
array: readonly T[],
getter: (item: T) => string,
dir: "asc" | "desc" = "asc",
) {
if (!array) return [];
const asc = (a: T, b: T) => `${getter(a)}`.localeCompare(getter(b));
const dsc = (a: T, b: T) => `${getter(b)}`.localeCompare(getter(a));
return array.slice().sort(dir === "desc" ? dsc : asc);
}