sortobject

Sort Object

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
• Require: require('sortobject')

jspm

<script type="module">
    import * as pkg from '//dev.jspm.io/sortobject'
</script>

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 esnext source code with require for modules
• sortobject/edition-browsers/index.js is esnext compiled for browsers with require for modules
• sortobject/edition-node-0.12/index.js is esnext compiled for node.js 0.12 with require for modules

TypeScript

This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5 or thereabouts. You can accomlish this via your tsconfig.json file like so:

{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 5
  }
}

Usage

API Documentation.

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:

• Benjamin Lupton — view contributions

Sponsors

These amazing people have contributed finances to this project:

• GoVests

Become a sponsor!

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions
• Serge Havas — view contributions
• James Newell — view contributions

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

License

Unless stated otherwise all works are:

• Copyright © 2012+ Bevry Pty Ltd

and licensed under:

• MIT License

Changelog

v1.2.0 2019 January 1

• Added JSDoc documentation
• Updated base files and editions using boundation