Skip to content

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

License

Notifications You must be signed in to change notification settings

bevry/arrangekeys

Repository files navigation

Arrange Keys

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

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

  • Install: npm install --save arrangekeys
  • Import: import pkg from ('arrangekeys')
  • Require: const pkg = require('arrangekeys').default
import pkg from 'https://unpkg.com/arrangekeys@^6.7.0/edition-deno/index.ts'
<script type="module">
    import pkg from '//cdn.skypack.dev/arrangekeys@^6.7.0'
</script>
<script type="module">
    import pkg from '//unpkg.com/arrangekeys@^6.7.0'
</script>
<script type="module">
    import pkg from '//dev.jspm.io/arrangekeys@6.7.0'
</script>

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

Maintainers

Contributors

Finances

GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button

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

License

Unless stated otherwise all works are:

and licensed under: