object-delete-key

object-delete-key

Delete keys from all arrays or plain objects, nested within anything, by key or by value or by both, and clean up afterwards. Accepts wildcards.

Install

This package is pure ESM. If you're not ready yet, install an older version of this program, 2.1.0 (npm i object-delete-key@2.1.0).

npm i object-delete-key

Quick Take

import { strict as assert } from "assert";

import { deleteKey } from "object-delete-key";

// deleting key 'c', with value 'd'
assert.deepEqual(
  deleteKey(
    {
      a: "b",
      c: "d",
    },
    {
      key: "c",
      val: "d",
    },
  ),
  { a: "b" },
);

// deleting key 'b' with value - array ['c', 'd']
assert.deepEqual(
  deleteKey(
    {
      a: { e: [{ b: ["c", "d"] }] },
      b: ["c", "d"],
    },
    {
      key: "b",
      val: ["c", "d"],
    },
  ),
  {},
);
// notice program cleaned after itself, it didn't leave empty "a" key

Documentation

Please visit codsen.com for a full description of the API.

Contributing

To report bugs or request features or assistance, raise an issue on GitHub.

Licence

MIT License.

Copyright © 2010-2024 Roy Revelt and other contributors.