| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960 |
- # sort-keys [](https://travis-ci.org/sindresorhus/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 --save sort-keys
- ```
- ## Usage
- ```js
- 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.](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)
- ## License
- MIT © [Sindre Sorhus](https://sindresorhus.com)
|
