sortobject

What is sortobject?

The sortobject npm package is a utility for sorting the keys of an object. It can be used to ensure consistent key ordering, which can be useful for tasks such as comparing objects, generating consistent JSON output, and more.

What are sortobject's main functionalities?

Sort object keys alphabetically

This feature sorts the keys of an object in alphabetical order. The code sample demonstrates how to use the sortobject package to sort the keys of an object.

const sortobject = require('sortobject');
const obj = { b: 2, a: 1, c: 3 };
const sortedObj = sortobject(obj);
console.log(sortedObj); // { a: 1, b: 2, c: 3 }

Sort nested object keys

This feature sorts the keys of nested objects as well. The code sample shows how nested objects are sorted by their keys.

const sortobject = require('sortobject');
const obj = { b: { d: 4, c: 3 }, a: 1 };
const sortedObj = sortobject(obj);
console.log(sortedObj); // { a: 1, b: { c: 3, d: 4 } }

Other packages similar to sortobject

sort-keys

The sort-keys package sorts the keys of an object in a similar manner to sortobject. It offers additional options such as sorting in reverse order and custom sorting functions. Compared to sortobject, sort-keys provides more flexibility in how the keys are sorted.

deep-sort-object

The deep-sort-object package sorts the keys of an object deeply, including nested objects. It is similar to sortobject in that it handles nested objects, but it also provides more control over the sorting process, such as custom sorting functions.

README

Sort Object

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

Install

Backend

1. Install Node.js
2. npm install --save sortobject

Frontend

1. See Browserify

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

You can discover the history inside the History.md file

Backers

Check out the Backers.md file to discover all the amazing people who financially supported the development of this project.

License

Licensed under the incredibly permissive MIT License
Copyright © 2013+ Bevry Pty Ltd

Changelog

v1.0.0 2013 April 20

• Initial working version