sort-es

Blazing fast, tree-shakeable, type-safe, modern utility library to sort any type of array

Docs : https://sort-es.netlify.app/

Getting started

installation

The library is available as a npm package. To install the package, run:

npm install sort-es
# or
yarn add sort-es

Start using:

1import {byString} from 'sort-es'
2
3const unsorted = ["xxx", "bbbb", "zzz", "cccc", "aaa"];
4const sorted = unsorted.sort(byString());
5
6console.log(sorted); //(5) ["aaa", "bbbb", "cccc", "xxx", "zzz"]

Use directly in the browser

1
2<script src='https://cdn.jsdelivr.net/npm/sort-es/dist/index.umd.js'></script>
3<script>
4  const unsorted = ["xxx", "bbbb", "zzz", "cccc", "aaa"];
5  const sorted = unsorted.sort(sort.byString());
6
7  console.log(sorted); //(5) ["aaa", "bbbb", "cccc", "xxx", "zzz"]
8</script>
9
10//or via browser modules
11
12<script type='module'>
13  import {byString} from 'https://cdn.jsdelivr.net/npm/sort-es/dist/index.mjs'
14
15  const unsorted = ["xxx", "bbbb", "zzz", "cccc", "aaa"];
16  const sorted = unsorted.sort(byString());
17
18  console.log(sorted); //(5) ["aaa", "bbbb", "cccc", "xxx", "zzz"]
19</script>

Some mind-blowing example

sort by a single property

1//js or ts file
2import {byValue, byNumber, byString} from 'sort-es'
3
4const arrayUnsorted = [
5  {prop: "xxx", foo: 34},
6  {prop: "aaa", foo: 325},
7  {prop: "zzz", foo: 15},
8  {prop: "ccc", foo: 340},
9  {prop: "bbb", foo: 0}
10];
11
12//this sort by the foo property ascending
13const sortedByFoo = arrayUnsorted.sort(byValue((i) => i.foo, byNumber()));
14console.log(sortedByFoo); //(5) [{prop: "bbb", foo : 0}, {prop: "zzz", foo: 15}, .....];
15
16//this sort by the prop property descending
17const sortedByProp = arrayUnsorted.sort(byValue((i) => i.prop, byString({desc: true})));
18console.log(sortedByProp); //(5) [{prop: "zzz", foo : 15}, {prop: "xxx", foo: 34}, .....];

sort by a multiple property

1//js or ts file
2import {byNumber, byString, byValues} from "sort-es";
3
4const objsToSort = [
5  {id: 2, name: 'teresa'},
6  {id: 3, name: 'roberto'},
7  {id: 2, name: 'roberto'}
8];
9
10//i sort by THEIR NAMES and THEN by their ids
11const sortedObject = objsToSort.sort(byValues([
12  [(x) => x.name, byString()],
13  [(x) => x.id, byNumber()]
14]));
15
16console.log(sortedObject); //[{roberto, 2}, {roberto, 3}, {teresa, 2}];
17
18//i sort by THEIR IDS and THEN by their names
19const sortedObject2 = objsToSort.sort(byValues([
20  [(x) => x.id, byNumber()],
21  [(x) => x.name, byString()]
22]));
23console.log(sortedObject2); //[{roberto, 2}, {teresa, 2}, {roberto, 3}];
24
25//i sort by THEIR IDS and THEN by their names DESCENDING
26const sortedObject3 = objsToSort.sort(byValues([
27  [(x) => x.id, byNumber()],
28  [(x) => x.name, byString({desc: true})],
29]));
30console.log(sortedObject3); //[{teresa, 2}, {roberto, 2}, {roberto, 3}];
31

typescript types check

1//ts file
2import {byValue, byNumber, byString} from 'sort-es'
3
4const objsArray = [{numbProp: 2, stringProp: 'a'}, {numbProp: 3, stringProp: 'f'}];
5
6//Incorrect sort property
7const incorrectSortedArray = objsArray.sort(byValue(i => i.numbProp, byString()));
8//ts check error : Type 'number' is not assignable to type 'string'.
9
10//Correct sort type
11const sortedArray = objsArray.sort(byValue(i => i.numbProp, byNumber()))
12//ts check ok
13

See full Docs

sort-es.netlify.app

License

MIT © Cosimo chellini