UNPKG

keysort

Version:

Sorts an Array of Objects with SQL ORDER BY clause syntax

github.com/avoidwork/keysort

avoidwork/keysort

37 lines (25 loc) • 1.24 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# keysort Sorts an Array of Objects with SQL ORDER BY clause syntax. ## Using the module ```javascript import {keysort} from "keysort"; const arr = [{abc: 123124, xyz: 5}, {abc: 123124, xyz: 6}, {abc: 2, xyz: 5}]; keysort(arr, "abc, xyz"); // [{abc: 2, xyz: 5}, {abc: 123124, xyz: 5}, {abc: 123124, xyz: 6}]; keysort(arr, "abc, xyz desc"); // [{abc: 2, xyz: 5}, {abc: 123124, xyz: 6}, {abc: 123124, xyz: 5}]; ``` ## Testing keysort has 100% code coverage with its tests. ```console -------------|---------|----------|---------|---------|------------------- File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s -------------|---------|----------|---------|---------|------------------- All files | 100 | 80 | 100 | 100 | keysort.cjs | 100 | 80 | 100 | 100 | 25 -------------|---------|----------|---------|---------|------------------- ``` ## API ### keysort(arr = [], order = "", toSorted = false) Sorts an `Array` of `Objects` with SQL ORDER BY clause syntax. If `toSorted` is `true`, a new sorted `Array` is returned. ## License Copyright (c) 2023 Jason Mulligan Licensed under the BSD-3 license.