Deeply sort an object by its keys without mangling any arrays inside of it
JavaScript
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
source
.editorconfig
.eslintrc.js
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
HISTORY.md
LICENSE.md
README.md
example.js
index.js
package.json

README.md

Sort Object

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Slack community badge Patreon donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Returns a copy of an object, sorted deeply by its keys, without mangling any arrays inside of it

Install

NPM

  • Install: npm install --save sortobject
  • Module: require('sortobject')

Browserify

  • Install: npm install --save sortobject
  • Module: require('sortobject')
  • CDN URL: //wzrd.in/bundle/sortobject@1.1.1

Ender

  • Install: ender add sortobject
  • Module: require('sortobject')

Editions

This package is published with the following editions:

  • sortobject aliases sortobject/index.js which uses Editions to automatically select the correct edition for the consumers environment
  • sortobject/source/index.js is Source + ESNext + Require
  • sortobject/es2015/index.js is Babel Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

var sortObject = require('sortobject')
var fixture = {
    "c": true,
    "a": true,
    "b": null,
    "d": [
        {
            "c": true,
            "a": true,
            "b": null
        },
        {
            "c": true,
            "a": true,
            "b": null,
            "d": [
                {
                    "c": true,
                    "a": true,
                    "b": null
                }
            ]
        }
    ]
}
var actual = sortObject(fixture)
console.log(JSON.stringify(actual,null,4))  /* {
    "a": true,
    "b": null,
    "c": true,
    "d": [
        {
            "a": true,
            "b": null,
            "c": true
        },
        {
            "a": true,
            "b": null,
            "c": true,
            "d": [
                {
                    "a": true,
                    "b": null,
                    "c": true
                }
            ]
        }
    ]
} */

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

These amazing people have contributed finances to this project:

Become a sponsor!

Patreon donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under: