arrangekeys
Returns a copy of a JavaScript object with the keys arranged in a specified order. Useful for formatting JSON files.
Last updated 4 years ago by bevryme .
MIT · Repository · Bugs · Original npm · Tarball · package.json 
$ npm install arrangekeys
SYNC missed versions from official npm registry.

Arrange Keys

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Returns a copy of a JavaScript object with the keys arranged in a specified order. Useful for formatting JSON files.

Usage

Complete API Documentation.

import arrangeKeys from 'arrangekeys'

// Arrange the keys of the input so that keys "b" and "c" are first
console.log(
    arrangeKeys(
        {
            z: 1,
            a: 2,
            b: 3,
            c: 4,
        },
        'b c'
    )
) /* {
	b: 3,
	c: 4,
	z: 1,
	a: 2
} */

// Arrange the keys of the input so that keys "b" and "c" are first, with the rest alphabetically sorted
console.log(
    arrangeKeys(
        {
            z: 1,
            a: 2,
            b: 3,
            c: 4,
        },
        'b c',
        true
    )
) /* {
	b: 3,
	c: 4,
	a: 2,
	z: 1
} */

// Arrange the keys to be alphabetically sorted
console.log(
    arrangeKeys({
        z: 1,
        a: 2,
        b: 3,
        c: 4,
    })
) /* {
	a: 2,
	b: 3,
	c: 4,
	z: 1
} */

Install

npm

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

Deno

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

Skypack

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

unpkg

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

jspm

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

Editions

This package is published with the following editions:

  • arrangekeys/source/index.ts is TypeScript source code with Import for modules
  • arrangekeys/edition-browsers/index.js is TypeScript compiled against ES2019 for web browsers with Import for modules
  • arrangekeys aliases arrangekeys/edition-esnext/index.js
  • arrangekeys/edition-esnext/index.js is TypeScript compiled against ESNext for Node.js 10 || 12 || 14 || 15 with Require for modules
  • arrangekeys/edition-esnext-esm/index.js is TypeScript compiled against ESNext for Node.js 12 || 14 || 15 with Import for modules
  • arrangekeys/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.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under:

Current Tags

114 Versions

Maintainers (2)
balupton
bevryme
Downloads
Total 1
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (0)
None
Dev Dependencies (18)
Dependents (1)

© 2010 - cnpmjs.org x YWFE | Home | YWFE