Sort Object

Returns a copy of an object with all keys sorted.

The second argument is optional and is used for ordering - to provide custom sorts. You can either pass an array containing ordered keys or a function to sort the keys (same signature as in Array.prototype.sort()).

1const assert = require('assert');
2const sortObject = require('sort-object-keys');
3
4assert.equal(JSON.stringify({
5  c: 1,
6  b: 1,
7  d: 1,
8  a: 1,
9}), JSON.stringify({
10  a: 1,
11  b: 1,
12  c: 1,
13  d: 1,
14}));
15
16assert.equal(JSON.stringify(sortObject({
17  c: 1,
18  b: 1,
19  d: 1,
20  a: 1,
21}, ['b', 'a', 'd', 'c'])), JSON.stringify({
22  b: 1,
23  a: 1,
24  d: 1,
25  c: 1,
26}));
27
28function removeKeyAncCompareIndex(keyA, keyB){
29  var a = parseInt(keyA.slice(4));
30  var b = parseInt(keyB.slice(4));
31  return a - b;
32}
33
34assert.equal(JSON.stringify(sortObject({
35  "key-1": 1,
36  "key-3": 1,
37  "key-10": 1,
38  "key-2": 1,
39}, removeKeyAncCompareIndex)), JSON.stringify({
40  "key-1": 1,
41  "key-2": 1,
42  "key-3": 1,
43  "key-10": 1,
44}));