Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
sort-object
Advanced tools
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.
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 }
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.
Sort the keys in an object.
Install with npm:
$ npm i sort-object --save
var sortObj = require('sort-object');
By default, the keys on an object will be sorted in ascending 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}
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.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}
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}
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}
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'}
Brian Woodward
Copyright © 2014-2016 Brian Woodward Released under the MIT license.
This file was generated by verb on February 03, 2016.
FAQs
Sort the keys in an object.
The npm package sort-object receives a total of 513,541 weekly downloads. As such, sort-object popularity was classified as popular.
We found that sort-object demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.