unset-value

Delete nested properties from an object using dot notation.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save unset-value

Usage

var unset = require('unset-value');
unset(obj, prop);

Params

• obj {object}: The object to unset prop on
• prop {string | string[]}: The property to unset. Dot-notation may be used or an array of nested properties.

Examples

Updates the object when a property is deleted

var obj = {a: 'b'};
unset(obj, 'a');
console.log(obj);
//=> {}

Returns true when a property is deleted

unset({a: 'b'}, 'a') // true

Returns true when a property does not exist

This is consistent with delete behavior in that it does not throw when a property does not exist.

unset({a: {b: {c: 'd'}}}, 'd') // true

delete nested values

var one = {a: {b: {c: 'd'}}};
unset(one, 'a.b');
console.log(one);
//=> {a: {}}

var two = {a: {b: {c: 'd'}}};
unset(two, ['a', 'b', 'c']);
console.log(two);
//=> {a: {b: {}}}

var three = {a: {b: {c: 'd', e: 'f'}}};
unset(three, 'a.b.c');
console.log(three);
//=> {a: {b: {e: 'f'}}}

throws on invalid args

unset();
// 'expected an object.'

About

$ npm install && npm test

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• get-value: Use property paths like 'a.b.c' to get a nested value from an object. Even works… more | homepage
• get-values: Return an array of all values from the given object. | homepage
• omit-value: Omit properties from an object or deeply nested property of an object using object path… more | homepage
• put-value: Update only existing values from an object, works with dot notation paths like a.b.c and… more | homepage
• set-value: Create nested values and any intermediaries using dot notation ('a.b.c') paths. | homepage
• union-value: Set an array of unique values as the property of an object. Supports setting deeply… more | homepage
• upsert-value: Update or set nested values and any intermediaries with dot notation ('a.b.c') paths. | homepage

Contributors

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2021, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.8.0, on March 18, 2021.

Current Tags

• 2.0.1                                ...           latest (3 years ago)

6 Versions

• 2.0.1                                ...           3 years ago
• 2.0.0                                ...           4 years ago
• 1.0.0                                ...           8 years ago
• 0.1.2                                ...           8 years ago
• 0.1.1                                ...           9 years ago
• 0.1.0                                ...           9 years ago