Package Exports

key-del

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (key-del) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Delete (nested) keys from JSON object

Assumptions

original object shall not be modified by default
modified object is returned
nested keys shall be deleted as well

Usage

takes two parameters (object, and keys to delete)
second parameter is a string (for single key), or array (for multiple keys)

Installation

npm install key-del

Usage

var deleteKey = require('key-del')
var objWithoutOneAttribute = deleteKey({one: 1, two: 2}, 'one')

Examples

var deleteKey = require('key-del')

var originalObject = {
    one: 1,
    two: 2,
    three: {
      nestedOne: 3,
      nestedTwo: 4
    }
}

var result = deleteKey(originalObject, ['one', 'nestedOne'])

console.log(result)
// {two: 2, three: {nestedTwo: 4}}

// Delete nested key by full path
var objectToDeleteKeyFrom = { one: 1, two: 2, nested: {two: 2, three: 3}}
var keyToDelete = 'nested.two'
var result = delKey(objectToDeleteKeyFrom, keyToDelete)
console.log(result)
// { one: 1, two: 2, nested: {three: 3}}

Options

To delete attribue from the original object, set copy parameter to false (its true by default)

deleteKey(originalObject, 'one', {copy: false})
console.log(originalObject)
// original object is modified
// { one: 1, two: 2, three: { nestedOne: 3, nestedTwo: 4 } }

Licence

The MIT License (MIT)