sort-object

What is sort-object?

The sort-object npm package is used to sort the keys of an object in JavaScript. It provides a simple and efficient way to order the properties of an object based on their keys, which can be useful for various purposes such as ensuring consistent key order for JSON serialization, improving readability, or preparing data for comparison.

What are sort-object'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 sort-object package to sort the keys of an object alphabetically.

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

Sort object keys with a custom comparator

This feature allows sorting the keys of an object using a custom comparator function. The code sample demonstrates how to use a custom comparator to sort the keys in reverse alphabetical order.

const sortObject = require('sort-object');
const obj = { b: 2, a: 1, c: 3 };
const sortedObj = sortObject(obj, { sort: (a, b) => b.localeCompare(a) });
console.log(sortedObj); // { c: 3, b: 2, a: 1 }

Other packages similar to sort-object

sort-keys

The sort-keys package sorts the keys of an object in a similar way to sort-object. It provides options for sorting keys alphabetically or using a custom comparator. Compared to sort-object, sort-keys offers additional features such as deep sorting of nested objects.

README

sort-object

Sort the keys in an object.

Install

Install with npm:

$ npm i sort-object --save

Usage

var sortObj = require('sort-object');

By default, the keys on an object will be sorted in descending order:

sortObj({a: 1, c: 2, b: 3});
//=> {a: 1, b: 3, c: 2}

The second param can be an object of options OR an array of keys:

object

sortObj({a: 1, c: 2, b: 3}, {keys: ['a', 'b']});
//=> {a: 1, b: 3}

array

sortObj({a: 1, c: 2, b: 3}, ['a', 'c']);
//=> {a: 1, c: 2}

Options

• keys {Array} The returned object will contain only the specified keys, in the same order.
• sort {Function} Sort function to sort the keys using JavaScript's .sort() method.
• sortOrder {String} Valid values are desc or asc, case insensitive.
• sortBy {String} Sort function that is passed the entire object, rather than just the keys - as with the .sort() method.

options.keys

Create a new object with only the given keys.

var o = {a: 1, c: 2, e: 5, d: 4, b: 3};
sortObj(o, {keys: ['a', 'b']});

//=> {a: 1, b: 3}

options.sort

Function to be passed to javascript's .sort() method:

var o = {a: 1, c: 2, e: 5, d: 4, b: 3};
var obj = sortObj(o, {
  sort: function (a, b) {
    return a < b ? -1 : 1;
  }
});
obj;
//=> {a: 1, b: 3, c: 2, d: 4, e: 5}

options.sortOrder

Valid values are desc or asc, case insensitive:

var o = {a: 1, c: 2, e: 5, d: 4, b: 3};
sortObj(o, {sortOrder: 'ASC'});
//=> {e: 5, d: 4, c: 3, b: 2, a: 1}

options.sortBy

Function that returns an array of keys to sort by:

var old = {one: 'aa', two: 'bc', three: 'ab'};
var o = sortObj(old, {
  sortBy: function (obj) {
    var arr = [];
    Object.keys(obj).filter(function(key) {
      if (/^a/.test(obj[key])) arr.push(key);
    });
    return arr.reverse();
  }
});
//=> {three: 'ab', one: 'aa'}

Author

Brian Woodward

• github/doowb
• twitter/jonschlinkert

License

Copyright © 2014-2016 Brian Woodward Released under the MIT license.

---

This file was generated by verb on January 19, 2016.