Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including unset-value with all npm packages installed. Try it out:

var unsetValue = require("unset-value")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

unset-value v1.0.0

Delete nested properties from an object using dot notation.

unset-value NPM version NPM monthly downloads NPM total downloads Linux Build Status

Delete nested properties from an object using dot notation.


Install with npm:

$ npm install --save unset-value


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

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


Updates the object when a property is deleted

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

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');
//=> {a: {}}

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

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

throws on invalid args

// 'expected an object.'


Related projects

  • get-value: Use property paths (a.b.c) to get a nested value from an object. | 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


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



Building docs

(This project's is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the 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


Jon Schlinkert


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

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

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free