README

Arrange Keys

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

Usage

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

Skypack

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

unpkg

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

jspm

<script type="module">
    import pkg from '//dev.jspm.io/arrangekeys@4.24.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 ES2020 for web browsers with Import for modules
arrangekeys aliases arrangekeys/edition-es2019/index.js
arrangekeys/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js 10 || 12 || 14 || 16 with Require for modules
arrangekeys/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js 12 || 14 || 16 with Import for modules