unset-value    

Delete nested properties from an object using dot notation.

Install

Install with npm:

sh
$ npm install --save unset-value

Usage

js
var unset = require('unset-value');

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

Examples

Updates the object when a property is deleted

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

Returns true when a property is deleted

js
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.

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

delete nested values

js
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

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

About

Related projects

• get-value: Use property paths (a.b.c) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value "Use property paths (a.b.c) to get a nested value from an object.")
• get-values: Return an array of all values from the given object. | [homepage](https://github.com/jonschlinkert/get-values "Return an array of all values from the given object.")
• omit-value: Omit properties from an object or deeply nested property of an object using object path… more | [homepage](https://github.com/jonschlinkert/omit-value "Omit properties from an object or deeply nested property of an object using object path notation.")
• put-value: Update only existing values from an object, works with dot notation paths like a.b.c and… more | [homepage](https://github.com/tunnckocore/put-value#readme "Update only existing values from an object, works with dot notation paths like a.b.c and support deep nesting.")
• set-value: Create nested values and any intermediaries using dot notation ('a.b.c') paths. | [homepage](https://github.com/jonschlinkert/set-value "Create nested values and any intermediaries using dot notation ('a.b.c') paths.")
• union-value: Set an array of unique values as the property of an object. Supports setting deeply… more | [homepage](https://github.com/jonschlinkert/union-value "Set an array of unique values as the property of an object. Supports setting deeply nested properties using using object-paths/dot notation.")
• upsert-value: Update or set nested values and any intermediaries with dot notation ('a.b.c') paths. | [homepage](https://github.com/doowb/upsert-value "Update or set nested values and any intermediaries with dot notation ('a.b.c') paths.")

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

Contributors

Building docs

_(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

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

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

sh
$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the [MIT License](LICENSE).

_This file was generated by verb-generate-readme, v0.4.2, on February 25, 2017._