arrangekeys

Arrange Keys

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@^6.7.0/edition-deno/index.ts'

Skypack

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

unpkg

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

jspm

<script type="module">
    import pkg from '//dev.jspm.io/arrangekeys@6.7.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 ES2022 for web browsers with Import for modules
• arrangekeys aliases arrangekeys/edition-es2022/index.js
• arrangekeys/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
• arrangekeys/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
• arrangekeys/edition-types/index.d.ts is TypeScript compiled Types 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.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

• Benjamin Lupton — Accelerating collaborative wisdom.

Maintainers

• Benjamin Lupton — Accelerating collaborative wisdom.

Contributors

• Benjamin Lupton — view contributions

Finances

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

• Andrew Nesbitt
• Armen Mkrtchian
• Balsa
• Chad
• Codecov
• dr.dimitru
• Elliott Ditman
• entroniq
• GitHub
• Hunter Beast
• Jean-Luc Geering
• Michael Duane Mooring
• Michael Harry Scepaniak
• Mohammed Shah
• Mr. Henry
• Nermal
• Pleo
• Poonacha Medappa
• Rob Morris
• Robert de Forest
• Sentry
• ServieJS
• Skunk Team
• Syntax
• WriterJohnBuck

License

Unless stated otherwise all works are:

• Copyright © Benjamin Lupton

and licensed under:

• Artistic License 2.0

Changelog

v6.7.0 2023 December 29

• Updated dependencies, base files, and editions using boundation
• Thank you to the sponsors: Andrew Nesbitt, Balsa, Codecov, Poonacha Medappa, Rob Morris, Sentry, Syntax