Sort the keys of an object


Keywords
sort, object, keys, key, stable, deterministic, deep, recursive, recursively
License
MIT
Install
npm install sort-keys@4.0.0

Documentation

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 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({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(object, options?)

Returns a new object with sorted keys.

object

Type: object

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.