jonschlinkert / unset-value Goto Github PK

Delete nested properties from an object using dot notation.

License: MIT License

JavaScript 100.00%

unset-value's Introduction

unset-value

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

This file was generated by verb-generate-readme, v0.8.0, on March 18, 2021.

unset-value's People

Contributors

Stargazers

Watchers

Forkers

buhlerscherler jenbelanger bluelovers silicon-beach-labs srinivas32 faizanu94 418sec alexmanoilo mpadev0103 popular-dependencies nikhilkky

unset-value's Issues

Nexus IQ server raising critical alerts for this package

From the alert:

The unset-value package is vulnerable to Prototype Pollution. The unset function in index.js files allows for access to object prototype properties. An attacker can exploit this to override the behavior of object prototypes, resulting in a possible Denial of Service (DoS), Remote Code Execution (RCE), or other unexpected behavior.

More explanation here:
https://cwe.mitre.org/data/definitions/1321.html

isObject is not a function

I am suddenly encountering this isssue where the isObject function is somehow not defined.

/*!
 * unset-value <https://github.com/jonschlinkert/unset-value>
 *
 * Copyright (c) 2015, 2017, Jon Schlinkert.
 * Released under the MIT License.
 */

'use strict';

var isObject = require('isobject');
var has = require('has-value');

const isUnsafeKey = key => {
  return key === '__proto__' || key === 'constructor' || key === 'prototype';
};

const validateKey = key => {
  if (isUnsafeKey(key)) {
    throw new Error(`Cannot set unsafe key: "${key}"`);
  }
};

module.exports = function unset(obj, prop) {
  if (!isObject(obj)) {                 // => throws error here because isObject is not a function
    throw new TypeError('expected an object.');
  }

  //...

Any ideas why this might be happening?

bug when `a.b\\.c.arr.2`

import deep from './deep.json'
import _has from "has-value";
import _unset from "unset-value";
import _get, { Options } from 'get-value';

let paths = 'a.b\\.c.arr.2';

expect(_has(deep, paths as any)).to.be.ok;
expect(_get(deep, paths as any)).to.be.deep.equal({
		d: {
			e: { arr: [ { f: false }, { f: false } ] }
		}
	}
);

_unset(deep, paths as any)

deep.json

Cant unset if property has 'no value'

Hi,
Im trying to unset a property with an empty array, but unset-value doesnt unset that property

const unsetValue = require('unset-value')

let data = {
    "a": "a",
    "b": {
        "b": [],
        "bb": 1
    },
    "c": []
}

unsetValue(data, 'b.b') // b.b isnt removed
console.log(data)

unsetValue(data, 'b.bb') // b.b is removed
console.log(data)

unsetValue(data, 'c') // b.b is removed ?
console.log(data)

Seems that the "problem" is with 'has-value', but it works as expected. Maybe this should be checked against 'has-property' ?

jonschlinkert / unset-value Goto Github PK

unset-value's Introduction

unset-value

Install

Usage

Params

Examples

Updates the object when a property is deleted

Returns true when a property is deleted

Returns true when a property does not exist

delete nested values

throws on invalid args

About

Related projects

Contributors

Author

License

unset-value's People

Contributors

Stargazers

Watchers

Forkers

unset-value's Issues

Recommend Projects

Recommend Topics

Recommend Org

Returns `true` when a property does not exist