UNPKG

motion

Version:

motion - moving development forward

64 lines (36 loc) 1.03 kB
# sort-keys [![Build Status](https://travis-ci.org/sindresorhus/sort-keys.svg?branch=master)](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 var 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: function (a, b) { return -a.localeCompare(b); } }); //=> {c: 0, b: 0, a: 0} ``` ## API ### sortKeys(input, [options]) Returns a new object with sorted keys. #### input *Required* 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](http://sindresorhus.com)