sortobject

Sort Object

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

Usage

Complete API Documentation.

import sortObject from 'sortobject'
const 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,
                },
            ],
        },
    ],
}
const 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
                }
            ]
        }
    ]
} */

Install

npm

• Install: npm install --save sortobject
• Import: import pkg from ('sortobject')
• Require: const pkg = require('sortobject').default

Deno

import pkg from 'https://unpkg.com/sortobject@^5.4.0/edition-deno/index.ts'

Skypack

<script type="module">
    import pkg from '//cdn.skypack.dev/sortobject@^5.4.0'
</script>

unpkg

<script type="module">
    import pkg from '//unpkg.com/sortobject@^5.4.0'
</script>

jspm

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

Editions

This package is published with the following editions:

• sortobject/source/index.ts is TypeScript source code with Import for modules
• sortobject/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
• sortobject aliases sortobject/edition-es2022/index.js
• sortobject/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 21 with Require for modules
• sortobject/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 21 with Import for modules
• sortobject/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
• sortobject/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

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

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions
• James Newell
• James Newell — view contributions
• Serge Havas — 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:

• Artistic License 2.0