unset-value
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

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

    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 ❤️ 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

    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:

    $ 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

    Commits Contributor
    11 jonschlinkert
    4 danez
    2 wtgtybhertgeghgtwtg
    1 TrySound
    1 bluelovers

    Author

    Jon Schlinkert

    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.

    Install

    npm i unset-value

    DownloadsWeekly Downloads

    16,312,966

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    9.6 kB

    Total Files

    5

    Last publish

    Collaborators

    • jonschlinkert
    • danez