sortArray()function
sortArray(input: ImmutableArray<T> | Iterable<T>, compare: Compare<T, A> = compareAscending as unknown as Compare<T, A>, ...args: A): ImmutableArray<T>
| Param | Type | |
|---|---|---|
input | ImmutableArray<T>Iterable<T> | The array or iterable of items to sort. required |
compare | Compare<T, A> | A Compare function ranking two items (defaults to compareAscending()). Defaults to compareAscending as unknown as Compare<T, A> |
args | A | Extra arguments forwarded to compare on each call. required |
| Return | |
|---|---|
ImmutableArray<T> | A sorted array (the original reference if it was an already-sorted array). |
Sort an iterable set of items using a ranker (defaults to sorting in ascending order).
- When the input is already an array and the sort makes no change, the original array reference is returned unchanged.
Examples
sortArray([3, 1, 2]) // [1, 2, 3]