json-keys-sort
Version:
Sorting a json object based on keys either ascending or descending & even recursively
192 lines (144 loc) • 6.38 kB
Markdown
# json-keys-sort
   [](https://app.travis-ci.com/DawnImpulse/json-keys-sort) [](https://coveralls.io/github/DawnImpulse/json-keys-sort?branch=master)   [](https://plant.treeware.earth/dawnimpulse/json-keys-sort)
> Sorting a json object based on keys either ascending or descending & even recursively
### Latest Changes (v2.2.0)
- **sortAsync** : Implemented event loop yielding mechanism
- Adding benchmarks
- MIT License
### Installation
`npm install json-keys-sort`
or
`yarn add json-keys-sort`
or
`bun add json-keys-sort`
### Example -
> Note : focus on **keys** not values
~~~~
const json = require('json-keys-sort');
var data = {
"zoho": 4,
"drake": 2,
"yogo": {
"jout": "3.2",
"aou": {
"yoyo": "3.1.3",
"aalo": "3.1.1",
"go": "3.1.2"
}
},
"abc": 1
}
// sync (return sorted data)
json.sort(data, true)
// async (return promise of sorted data)
json.sortAsync(data, true)
~~~~
Output will be -
~~~~
{
"abc": 1,
"drake": 2,
"yogo": {
"aou": {
"aalo": "3.1.1",
"go": "3.1.2",
"yoyo": "3.1.3"
},
"jout": "3.2"
},
"zoho": 4
}
~~~~
+ function parameters (for both **sort** & **sortAsync**)
- **data:** the json object to sort
- **sort:**
- true (default) : ascending sort , since it is default you can only call `json.sort(data)` or `json.sortAsync(data)`
- false : descending sort
+ The function work recursively and sort all the inner json objects too.
### Benchmark
* You can also run it on your machine
* Clone project
* `yarn install`
* `yarn run benchmark`
Result from my machine :
```
=== Machine Details ===
OS: Node.js 22.14.0 on Darwin 24.6.0
CPU: Apple M1 Pro
Memory: 16GB
Node.js Version: 2.1.4
=====================
=== Shallow Objects ===
=== Benchmarking Sync Shallow small ===
Shallow small x 4,575,482 ops/sec ±0.66% (94 runs sampled)
=== Benchmarking Sync Shallow medium ===
Shallow medium x 79,882 ops/sec ±0.89% (96 runs sampled)
=== Benchmarking Sync Shallow large ===
Shallow large x 2,439 ops/sec ±0.66% (99 runs sampled)
=== Nested Objects ===
=== Benchmarking Sync Nested small ===
Nested small x 1,199,448 ops/sec ±0.26% (98 runs sampled)
=== Benchmarking Sync Nested medium ===
Nested medium x 70,191 ops/sec ±1.12% (98 runs sampled)
=== Benchmarking Sync Nested large ===
Nested large x 3,063 ops/sec ±3.19% (95 runs sampled)
=== Mixed Objects ===
=== Benchmarking Sync Mixed data ===
Mixed data x 9,585 ops/sec ±0.74% (95 runs sampled)
=== Async Benchmarks ===
=== Benchmarking Async Large Shallow ===
Large Shallow x 1,698 ops/sec ±0.27% (90 runs sampled)
=== Benchmarking Async Large Nested ===
Large Nested x 1,002 ops/sec ±0.89% (87 runs sampled)
=== Benchmarking Async Mixed Data ===
Mixed Data x 2,765 ops/sec ±1.35% (90 runs sampled)
```
### Versions
+ `v2.2.0`
+ **sortAsync** : Implemented event loop yielding mechanism
+ Adding benchmarks
+ MIT License
+ `v2.1.0`
+ **sortAsync** : this is a new function which returns a promise
+ `v2.0.0`
+ New : **100%** code coverage
+ Improvement : **sort** now throws an error if not provided with an object
+ `v1.3.1`
+ Bug Fix : Fixed type of parameter in sort function from JSON to object
+ `v1.3.0`
+ Included support for typescript (added declaration file)
+ `v1.2.0`
+ Improvement : json array support
+ `v1.1.0`
+ Bug Fixed : descending sort fix
+ Improvement: auto build testing via travis-ci
+ `v1.0.1`
+ Bug Fixed : data null checks & default true fix
+ `v1.0.0`
+ Initial release - containing basic `sort` function only.
> Pull requests are always welcomed (kindly sign commits with GPG keys. **THANKS**)
### Contact
Twitter - [@dawnimpulse](https://twitter.com/dawnimpulse)
Email - [dawnimpulse@gmail.com](mailto://dawnimpulse@gmail.com)
### Treeware
This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/dawnimpulse/json-keys-sort) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
### License (ISC)
~~~~
MIT License
Copyright (c) 2025 Codevry Labs (Saksham Khurana)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
~~~~