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

2.0.0-next.1574656655.1e509ba888bade14e4ba4002e3c810c1760c352b • Public • Published

Arrange Keys

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
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.

Install

npm

  • Install: npm install --save arrangekeys
  • Require: require('arrangekeys')

jspm

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

This package is published with the following editions:

  • arrangekeys aliases arrangekeys/source/index.js
  • arrangekeys/source/index.js is esnext source code with require for modules
  • arrangekeys/edition-browsers/index.js is esnext compiled for browsers with require for modules

This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5 or thereabouts. You can accomlish this via your tsconfig.json file like so:

{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 5
  }
}

Usage

API Documentation.

// Arrange the keys of the input so that keys "b" and "c" are first
console.log(
    require('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(
    require('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(
    require('arrangekeys')({
        z: 1,
        a: 2,
        b: 3,
        c: 4
    })
) /* {
	a: 2,
	b: 3,
	c: 4,
	z: 1
} */

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?

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:

Package Sidebar

Install

npm i arrangekeys@2.0.0-next.1574656655.1e509ba888bade14e4ba4002e3c810c1760c352b

Version

2.0.0-next.1574656655.1e509ba888bade14e4ba4002e3c810c1760c352b

License

MIT

Unpacked Size

21.9 kB

Total Files

8

Last publish

Collaborators

  • bevryme