sort-keys-depth
v1.0.1
Published
Sort the keys of an object
Downloads
5
Maintainers
Readme
sort-keys-depth
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-depth
Usage
import sortKeys from 'sort-keys-depth';
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 | number
Default: false
Recursively sort keys, including keys of objects inside arrays.
compare
Type: Function