sfcode: unset-value <a href="https://www.npmjs.com/package/unset-value"><img src="https://img.shields.io/npm/v/unset-value.svg?style=flat" alt="NPM version"/></a> <a href="https://npmjs.org/package/unset-value"><img src="https://img.shields.io/npm/dm/unset-value.svg?style=flat" alt="NPM monthly downloads"/></a> <a href="https://npmjs.org/package/unset-value"><img src="https://img.shields.io/npm/dt/unset-value.svg?style=flat" alt="NPM total downloads"/></a> <a href="https://travis-ci.org/jonschlinkert/unset-value"><img src="https://img.shields.io/travis/jonschlinkert/unset-value.svg?style=flat&label=Travis" alt="Linux Build Status"/></a>
unset-value

> Delete nested properties from an object using dot notation.

# Install

Install with npm:

$ npm install --save unset-value

# Usage

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

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

## Returns true when a property is deleted

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

## Returns <tt>true</tt> 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

## 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
- 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](https://github.com/jonschlinkert/set-value "Create nested values and any intermediaries using dot notation (</tt>'a.b.c'`) paths.")`
- `[union-value](https://www.npmjs.com/package/union-value): Set an array of unique values as the property of an object. Supports setting deeply… [more](https://github.com/jonschlinkert/union-value) | [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](https://www.npmjs.com/package/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 (&lsquo;'a.b.c&rsquo;`) paths.")`

``

## Contributing

`Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.`

``

## Contributors

``

Commits | Contributor
--- | ---
6 | jonschlinkert
2 | wtgtybhertgeghgtwtg

``

## 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:`

``

$ 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:`

``

$ 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.`