Returns a copy of a JavaScript object with the keys arranged in a specified order. Useful for formatting JSON files.
- Install:
npm install --save arrangekeys
- Require:
require('arrangekeys')
<script type="module">
import * as pkg from '//dev.jspm.io/arrangekeys'
</script>
This package is published with the following editions:
-
arrangekeys
aliasesarrangekeys/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
}
}
// 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
} */
Discover the release history by heading on over to the HISTORY.md
file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Unless stated otherwise all works are:
- Copyright © 2014+ Bevry Pty Ltd
and licensed under: