sortobject
TypeScript icon, indicating that this package has built-in type declarations

5.6.0 • Public • Published

Sort Object

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

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

Usage

Complete API Documentation.

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

  • Install: npm install --save sortobject
  • Import: import pkg from ('sortobject')
  • Require: const pkg = require('sortobject').default

Deno

import pkg from 'https://unpkg.com/sortobject@^5.6.0/edition-deno/index.ts'

Skypack

<script type="module">
    import pkg from '//cdn.skypack.dev/sortobject@^5.6.0'
</script>

unpkg

<script type="module">
    import pkg from '//unpkg.com/sortobject@^5.6.0'
</script>

jspm

<script type="module">
    import pkg from '//dev.jspm.io/sortobject@5.6.0'
</script>

Editions

This package is published with the following editions:

  • sortobject/source/index.ts is TypeScript source code with Import for modules
  • sortobject/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
  • sortobject aliases sortobject/edition-es2022/index.js
  • sortobject/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
  • sortobject/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
  • sortobject/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
  • sortobject/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

Maintainers

Contributors

Finances

GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button

Funders

Sponsors

  • Andrew Nesbitt — Software engineer and researcher
  • Balsa — We're Balsa, and we're building tools for builders.
  • Codecov — Empower developers with tools to improve code quality and testing.
  • Poonacha Medappa
  • Rob Morris
  • Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
  • Syntax — Syntax Podcast

Donors

License

Unless stated otherwise all works are:

and licensed under:

Package Sidebar

Install

npm i sortobject

Weekly Downloads

100,310

Version

5.6.0

License

Artistic-2.0

Unpacked Size

47.9 kB

Total Files

15

Last publish

Collaborators

  • bevryme