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
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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:
$ npm install && npm test
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 readme template.)
To generate the readme, run the following command: