Archived

This repository has been archived on 2020-11-02. You can view files and clone it, but cannot push or open issues or pull requests.

History

cranberry ed23347e56 Initial comission of TheLounge base files		2020-11-01 22:46:04 +00:00
..
index.js	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
license	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
package.json	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
readme.md	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00

readme.md

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

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.