@y13i/sort-keys

sort-keys

Sort the keys of an object.

• Live Demo
• Benchmark

Installation

npm install @y13i/sort-keys

Usage

import { sortKeys } from "@y13i/sort-keys";

sortKeys(object, option?)

Returns a new object with sorted keys.

sortKeys({ name: "Alice", age: 30, city: "Tokyo" });
// => { age: 30, city: "Tokyo", name: "Alice" }

object

Type: object

The object to sort keys of.

option

Type: object

option.depth

Type: number (1 or greater integer)

Default: Infinity

Limits how many levels deep to recursively sort. 1 sorts only the top-level object; the default Infinity sorts all nested objects and arrays.

sortKeys(
  { version: 1, author: { name: "Alice", email: "[e-mail]" } },
  { depth: 1 }
);
// => { author: { name: "Alice", email: "[e-mail]" }, version: 1 }
// (nested object left unsorted)

option.prioritize.keys

Type: string[]

Keys listed here are moved to the front, in the order given, before the remaining keys are sorted alphabetically.

sortKeys(
  { spec: {}, kind: "Deployment", metadata: {}, apiVersion: "apps/v1" },
  { prioritize: { keys: ["apiVersion", "kind", "metadata"] } }
);
// => { apiVersion: "apps/v1", kind: "Deployment", metadata: {}, spec: {} }

option.prioritize.primitives

Type: boolean

When true, keys with primitive values (numbers, strings, booleans, null, undefined) are sorted before keys with object or array values.

sortKeys(
  { scripts: { build: "tsc" }, name: "my-app", version: "1.0.0", dependencies: { react: "^18.0.0" } },
  { prioritize: { primitives: true } }
);
// => { name: "my-app", version: "1.0.0", dependencies: { react: "^18.0.0" }, scripts: { build: "tsc" } }

option.compare

Type: Function, (object) => (leftKey: string, rightKey: string) => number

Custom sort logic. The outer function receives the object being sorted; the inner comparator receives two key names and returns a number, following the same convention as Array.prototype.sort. When provided, prioritize options are ignored.

sortKeys(
  { createdAt: "2024-01-01", id: 1, title: "Hello" },
  {
    compare: () => (left, right) => left.length - right.length || left.localeCompare(right),
  }
);
// => { id: 1, title: "Hello", createdAt: "2024-01-01" }  (sorted by key length)

CLI

See y13i/sort-keys-cli.

Prior art

• sort-keys
• sort-object-keys