sindresorhus / sort-keys

Sort the keys of an object

sort-keys

Sort the keys of an object

Useful to get a deterministically ordered object, as the order of keys can vary between engines.

Install

$ npm install sort-keys

Usage

import sortKeys from 'sort-keys';

sortKeys({c: 0, a: 0, b: 0});
//=> {a: 0, b: 0, c: 0}

sortKeys({b: {b: 0, a: 0}, a: 0}, {deep: true});
//=> {a: 0, b: {a: 0, b: 0}}

sortKeys({b: [{b: 0, a: 0}], a: 0}, {deep: true});
//=> {a: 0, b: [{a: 0, b: 0}]}

sortKeys({c: 0, a: 0, b: 0}, {
	compare: (a, b) => -a.localeCompare(b)
});
//=> {c: 0, b: 0, a: 0}

sortKeys([{b: 0, a:2}], {deep: true});
//=> [{a: 2, b: 0}]

API

sortKeys(object, options?)

Returns a new object with sorted keys.

object

Type: object | Array

options

Type: object

deep

Type: boolean
Default: false

Recursively sort keys, including keys of objects inside arrays.

compare

Type: Function

Compare function.

---

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}

sort-keys's Issues

Lint error in typescript

Hello,
i am using sortKeys in a typescript project, but getting a lint error:
sortKeys({a: 0, b: 1});

Results in:

This expression is not callable.
Type '{ default: <T extends { [key: string]: any; }>(object: T, opt
ions?: Options | undefined) => T; }' has no call signatures.

The same result i am getting by using an object of type any:

    private generateParams(p: any, p1: string, p2: string): string {
        const sorted = sortKeys(p);

Regards
nowrap

v5 breaks backwards compat

The package.json#module path should point to the esm bundle and a commonjs bundle should be built and package.json#main path should point to the commonjs build.

Deep option causes infinite recursion on indirectly circular objects

var sortKeys = require('sort-keys');
var obj = {};
obj.nested = {original: obj};
sortKeys(obj, {deep: true});            //stack overflow

Incorrect behavior for deep sort of directly circular objects

var sortKeys = require('sort-keys');
var obj = { z: 0 };
obj.self = obj;
var sortedObj = sortKeys(obj, {deep:true});
console.log(sortedObj);                 //{ self: { z: 0, self: [Circular] }, z: 0 }
console.log(sortedObj.self === obj);    //true

That is, sortedObj still contains a reference to obj (whose keys are unsorted) rather than itself.

feat: add support for Arrays

Right now you can't pass an Array to sortKeys(...) - ideally we should be able to pass an Array (e.g. an Array of objects) or a plain Object to the method exported.

Related: #10

Objects inside arrays still need sorting

I had to write my own sorter, but would be great if you added this to your code - an ability to sort objects inside arrays, without changing the position in the arrays themselves.

{
  b: 1
  a: [ { f: 10, e: 11 }, { h: 20, g: 21 }]
}

after sort:

{
  a: [ { e: 11, f: 10 }, { g: 21, h: 20 }]
  b: 1
}

Arrays are getting converted to key-values when deep = true

Hi,

I have a little problem using the deep option on an object containing arrays.

Every array will be converted to an object f.e:

{
  "a": [3, 4, 5]
}

will be

{
  "a": {"0": 3, "1": 4, "2": 5}
}

See test case below:

it('deep option (containing array)', function () {
  assert.strictEqual(
    JSON.stringify(sortKeys({c: {c: 0, a: 0, b: 0}, a: 0, b: 0, z: [9, 8, 7, 6, 5]}, {deep: true})),
    JSON.stringify({a: 0, b: 0, c: {a: 0, b: 0, c: 0}, z: [9, 8, 7, 6, 5]})
  );

  assert.doesNotThrow(function () {
    var obj = {a: 0};
    obj.circular = obj;
    sortKeys(obj, {deep: true});
  });
});

Kind regards