Sort the keys of an object
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.editorconfig
.gitattributes
.gitignore init Jun 28, 2014
.travis.yml Require Node.js 4 Jun 9, 2017
index.js Use `for...of` and remove deprecation notice (#7) Jun 16, 2017
license Require Node.js 4 Jun 9, 2017
package.json 2.0.0 Jun 9, 2017
readme.md meta tweaks May 18, 2016
test.js

readme.md

sort-keys Build Status

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 --save sort-keys

Usage

const sortKeys = require('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({c: 0, a: 0, b: 0}, {
	compare: (a, b) => -a.localeCompare(b)
});
//=> {c: 0, b: 0, a: 0}

API

sortKeys(input, [options])

Returns a new object with sorted keys.

input

Type: Object

options

deep

Type: boolean

Recursively sort keys.

compare

Type: Function

Compare function.

License

MIT © Sindre Sorhus