https://github.com/bevry/sortobject
Deeply sort an object by its keys without mangling any arrays inside of it
https://github.com/bevry/sortobject
client-side data-manipulation nodejs object-sort
Last synced: about 1 month ago
JSON representation
Deeply sort an object by its keys without mangling any arrays inside of it
- Host: GitHub
- URL: https://github.com/bevry/sortobject
- Owner: bevry
- License: other
- Created: 2013-04-20T06:16:18.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-10-18T16:22:16.000Z (2 months ago)
- Last Synced: 2025-10-19T09:54:11.957Z (about 2 months ago)
- Topics: client-side, data-manipulation, nodejs, object-sort
- Language: TypeScript
- Size: 768 KB
- Stars: 8
- Watchers: 0
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome_frontend_development_resources - sortobject - Deeply sort an object by its keys without mangling any arrays inside of it. (Object / React Components)
- awesome - sortobject - Deeply sort an object by its keys without mangling any arrays inside of it. (Object / React Components)
README
# Sort Object
Returns a copy of an object, sorted deeply by its keys, without mangling any arrays inside of it
## Usage
[Complete API Documentation.](http://master.sortobject.bevry.surge.sh/docs/)
```javascript
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](https://npmjs.com "npm is a package manager for javascript")
- Install: `npm install --save sortobject`
- Import: `import pkg from ('sortobject')`
- Require: `const pkg = require('sortobject').default`
### [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js")
``` typescript
import pkg from 'https://unpkg.com/sortobject@^5.6.0/edition-deno/index.ts'
```
### [Skypack](https://www.skypack.dev "Skypack is a JavaScript Delivery Network for modern web apps")
``` html
import pkg from '//cdn.skypack.dev/sortobject@^5.6.0'
```
### [unpkg](https://unpkg.com "unpkg is a fast, global content delivery network for everything on npm")
``` html
import pkg from '//unpkg.com/sortobject@^5.6.0'
```
### [jspm](https://jspm.io "Native ES Modules CDN")
``` html
import pkg from '//dev.jspm.io/sortobject@5.6.0'
```
### [Editions](https://editions.bevry.me "Editions are the best way to produce and consume packages you care about.")
This package is published with the following editions:
- `sortobject/source/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `sortobject/edition-browsers/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for web browsers with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `sortobject` aliases `sortobject/edition-es2022/index.js`
- `sortobject/edition-es2022/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
- `sortobject/edition-es2022-esm/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 12 || 14 || 16 || 18 || 20 || 21 with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `sortobject/edition-types/index.d.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled Types with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `sortobject/edition-deno/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code made to be compatible with [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative to Node.js")
## History
[Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/sortobject/blob/HEAD/HISTORY.md#files)
## Backers
### Code
[Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/sortobject/blob/HEAD/CONTRIBUTING.md#files)
#### Authors
- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
#### Maintainers
- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
#### Contributors
- [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/sortobject/commits?author=balupton "View the GitHub contributions of Benjamin Lupton on repository bevry/sortobject")
- [James Newell](https://jameslnewell.me)
- [James Newell](https://github.com/jameslnewell) — [view contributions](https://github.com/bevry/sortobject/commits?author=jameslnewell "View the GitHub contributions of James Newell on repository bevry/sortobject")
- [Serge Havas](https://github.com/Sinewyk) — [view contributions](https://github.com/bevry/sortobject/commits?author=Sinewyk "View the GitHub contributions of Serge Havas on repository bevry/sortobject")
### Finances
#### Funders
- [GoVests](https://govests.com.au)
#### Sponsors
- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher
- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.
- [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing.
- [Poonacha Medappa](https://poonachamedappa.com)
- [Rob Morris](https://github.com/Rob-Morris)
- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.
- [Syntax](https://syntax.fm) — Syntax Podcast
#### Donors
- [Andrew Nesbitt](https://nesbitt.io)
- [Armen Mkrtchian](https://mogoni.dev)
- [Balsa](https://balsa.com)
- [Chad](https://opencollective.com/chad8)
- [Codecov](https://codecov.io)
- [dr.dimitru](https://veliovgroup.com)
- [Elliott Ditman](https://elliottditman.com)
- [entroniq](https://gitlab.com/entroniq)
- [GitHub](https://github.com/about)
- [GoVests](https://govests.com.au)
- [Hunter Beast](https://cryptoquick.com)
- [Jean-Luc Geering](https://github.com/jlgeering)
- [Michael Duane Mooring](https://mdm.cc)
- [Michael Harry Scepaniak](https://michaelscepaniak.com)
- [Mohammed Shah](https://github.com/smashah)
- [Mr. Henry](https://mrhenry.be)
- [Nermal](https://arjunaditya.vercel.app)
- [Pleo](https://pleo.io)
- [Poonacha Medappa](https://poonachamedappa.com)
- [Rob Morris](https://github.com/Rob-Morris)
- [Robert de Forest](https://github.com/rdeforest)
- [Sentry](https://sentry.io)
- [ServieJS](https://github.com/serviejs)
- [Skunk Team](https://skunk.team)
- [Syntax](https://syntax.fm)
- [WriterJohnBuck](https://github.com/WriterJohnBuck)
## License
Unless stated otherwise all works are:
- Copyright © [Benjamin Lupton](https://balupton.com)
and licensed under:
- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)