object-delete-key^4.2.1

Installation

Quick Take

Examples

• Deletion by the key only
• Deletion by the value only
• Disable the cleanup which would otherwise happen after deletion
• Delete only when both the key and value match
• Delete matching object keys without deleting matching array values
• Wildcards

Deleting

Three modes:

• Delete all key/value pairs found in any nested plain objects where key equals value.
• Delete all key/value pairs found in any nested plain objects where key is equal to a certain thing. value doesn’t matter.
• Delete all key/value pairs found in any nested plain objects where value is equal to a certain thing. key doesn’t matter.

This library accepts anything as input, including parsed HTML, which is deeply nested arrays of plain objects, arrays and strings. You can feed anything as input into this library — if it’s traversable, it will be traversed and searched for your key and/or value in any plain objects.

If you want to delete any nested objects that contain certain key/value pair(s), check out ast-delete-object.

API — deleteKey()

The main function deleteKey() is imported like this:

It’s a function which takes three input arguments:

The Obligatory Options Object has the following shape:

^ — at least one, key or val must be present.

Function returns the input with all requested keys/value pairs removed.

API — types

This package is written in TypeScript and exports the following types:

import type { Obj, Opts } from "object-delete-key";

Changelog