pax_global_header00006660000000000000000000000064142014523500014506gustar00rootroot0000000000000052 comment=3f61f4fc28bd40252c0e86f1bfab0a27a347e9f9 unset-value-2.0.1/000077500000000000000000000000001420145235000137565ustar00rootroot00000000000000unset-value-2.0.1/.editorconfig000066400000000000000000000004051420145235000164320ustar00rootroot00000000000000root = true [*] indent_style = space end_of_line = lf charset = utf-8 indent_size = 2 trim_trailing_whitespace = true insert_final_newline = true [{**/{actual,fixtures,expected,templates}/**,*.md}] trim_trailing_whitespace = false insert_final_newline = falseunset-value-2.0.1/.eslintrc.json000066400000000000000000000071251420145235000165570ustar00rootroot00000000000000{ "ecmaFeatures": { "modules": true, "experimentalObjectRestSpread": true }, "env": { "browser": false, "es6": true, "node": true, "mocha": true }, "globals": { "document": false, "navigator": false, "window": false }, "rules": { "accessor-pairs": 2, "arrow-spacing": [2, { "before": true, "after": true }], "block-spacing": [2, "always"], "brace-style": [2, "1tbs", { "allowSingleLine": true }], "comma-dangle": [2, "never"], "comma-spacing": [2, { "before": false, "after": true }], "comma-style": [2, "last"], "constructor-super": 2, "curly": [2, "multi-line"], "dot-location": [2, "property"], "eol-last": 2, "eqeqeq": [2, "allow-null"], "generator-star-spacing": [2, { "before": true, "after": true }], "handle-callback-err": [2, "^(err|error)$" ], "indent": [2, 2, { "SwitchCase": 1 }], "key-spacing": [2, { "beforeColon": false, "afterColon": true }], "keyword-spacing": [2, { "before": true, "after": true }], "new-cap": [2, { "newIsCap": true, "capIsNew": false }], "new-parens": 2, "no-array-constructor": 2, "no-caller": 2, "no-class-assign": 2, "no-cond-assign": 2, "no-const-assign": 2, "no-control-regex": 2, "no-debugger": 2, "no-delete-var": 2, "no-dupe-args": 2, "no-dupe-class-members": 2, "no-dupe-keys": 2, "no-duplicate-case": 2, "no-empty-character-class": 2, "no-eval": 2, "no-ex-assign": 2, "no-extend-native": 2, "no-extra-bind": 2, "no-extra-boolean-cast": 2, "no-extra-parens": [2, "functions"], "no-fallthrough": 2, "no-floating-decimal": 2, "no-func-assign": 2, "no-implied-eval": 2, "no-inner-declarations": [2, "functions"], "no-invalid-regexp": 2, "no-irregular-whitespace": 2, "no-iterator": 2, "no-label-var": 2, "no-labels": 2, "no-lone-blocks": 2, "no-mixed-spaces-and-tabs": 2, "no-multi-spaces": 2, "no-multi-str": 2, "no-multiple-empty-lines": [2, { "max": 1 }], "no-native-reassign": 0, "no-negated-in-lhs": 2, "no-new": 2, "no-new-func": 2, "no-new-object": 2, "no-new-require": 2, "no-new-wrappers": 2, "no-obj-calls": 2, "no-octal": 2, "no-octal-escape": 2, "no-proto": 0, "no-redeclare": 2, "no-regex-spaces": 2, "no-return-assign": 2, "no-self-compare": 2, "no-sequences": 2, "no-shadow-restricted-names": 2, "no-spaced-func": 2, "no-sparse-arrays": 2, "no-this-before-super": 2, "no-throw-literal": 2, "no-trailing-spaces": 0, "no-undef": 2, "no-undef-init": 2, "no-unexpected-multiline": 2, "no-unneeded-ternary": [2, { "defaultAssignment": false }], "no-unreachable": 2, "no-unused-vars": [2, { "vars": "all", "args": "none" }], "no-useless-call": 0, "no-with": 2, "one-var": [0, { "initialized": "never" }], "operator-linebreak": [0, "after", { "overrides": { "?": "before", ":": "before" } }], "padded-blocks": [0, "never"], "quotes": [2, "single", "avoid-escape"], "radix": 2, "semi": [2, "always"], "semi-spacing": [2, { "before": false, "after": true }], "space-before-blocks": [2, "always"], "space-before-function-paren": [2, "never"], "space-in-parens": [2, "never"], "space-infix-ops": 2, "space-unary-ops": [2, { "words": true, "nonwords": false }], "spaced-comment": [0, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }], "use-isnan": 2, "valid-typeof": 2, "wrap-iife": [2, "any"], "yoda": [2, "never"] } } unset-value-2.0.1/.gitattributes000066400000000000000000000002001420145235000166410ustar00rootroot00000000000000# Enforce Unix newlines * text eol=lf # binaries *.ai binary *.psd binary *.jpg binary *.gif binary *.png binary *.jpeg binary unset-value-2.0.1/.gitignore000066400000000000000000000004171420145235000157500ustar00rootroot00000000000000# always ignore files *.DS_Store *.sublime-* # test related, or directories generated by tests test/actual actual coverage .nyc* # npm node_modules npm-debug.log # yarn yarn.lock yarn-error.log # misc _gh_pages _draft _drafts bower_components vendor temp tmp TODO.md unset-value-2.0.1/.travis.yml000066400000000000000000000001061420145235000160640ustar00rootroot00000000000000os: - linux - osx language: node_js node_js: - 14 - 12 - 10 unset-value-2.0.1/.verb.md000066400000000000000000000020621420145235000153140ustar00rootroot00000000000000## Usage ```js var unset = require('{%= name %}'); 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 ```js var obj = {a: 'b'}; unset(obj, 'a'); console.log(obj); //=> {} ``` ### Returns true when a property is deleted ```js 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. ```js unset({a: {b: {c: 'd'}}}, 'd') // true ``` ### delete nested values ```js 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 ```js unset(); // 'expected an object.' ``` unset-value-2.0.1/LICENSE000066400000000000000000000021001420145235000147540ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2015, 2017, Jon Schlinkert Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. unset-value-2.0.1/README.md000066400000000000000000000137061420145235000152440ustar00rootroot00000000000000# unset-value [![NPM version](https://img.shields.io/npm/v/unset-value.svg?style=flat)](https://www.npmjs.com/package/unset-value) [![NPM monthly downloads](https://img.shields.io/npm/dm/unset-value.svg?style=flat)](https://npmjs.org/package/unset-value) [![NPM total downloads](https://img.shields.io/npm/dt/unset-value.svg?style=flat)](https://npmjs.org/package/unset-value) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/unset-value.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/unset-value) > Delete nested properties from an object using dot notation. Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. ## Install Install with [npm](https://www.npmjs.com/): ```sh $ npm install --save unset-value ``` ## Usage ```js 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 ```js var obj = {a: 'b'}; unset(obj, 'a'); console.log(obj); //=> {} ``` ### Returns true when a property is deleted ```js 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. ```js unset({a: {b: {c: 'd'}}}, 'd') // true ``` ### delete nested values ```js 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 ```js unset(); // 'expected an object.' ``` ## About
Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
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: ```sh $ npm install && npm test ```
Building docs _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: ```sh $ npm install -g verbose/verb#dev verb-generate-readme && verb ```
### Related projects You might also be interested in these projects: - [get-value](https://www.npmjs.com/package/get-value): Use property paths like 'a.b.c' to get a nested value from an object. Even works… [more](https://github.com/jonschlinkert/get-value) | [homepage](https://github.com/jonschlinkert/get-value "Use property paths like 'a.b.c' to get a nested value from an object. Even works when keys have dots in them (no other dot-prop library can do this!).") - [get-values](https://www.npmjs.com/package/get-values): Return an array of all values from the given object. | [homepage](https://github.com/jonschlinkert/get-values "Return an array of all values from the given object.") - [omit-value](https://www.npmjs.com/package/omit-value): Omit properties from an object or deeply nested property of an object using object path… [more](https://github.com/jonschlinkert/omit-value) | [homepage](https://github.com/jonschlinkert/omit-value "Omit properties from an object or deeply nested property of an object using object path notation.") - [put-value](https://www.npmjs.com/package/put-value): Update only existing values from an object, works with dot notation paths like `a.b.c` and… [more](https://github.com/tunnckocore/put-value#readme) | [homepage](https://github.com/tunnckocore/put-value#readme "Update only existing values from an object, works with dot notation paths like `a.b.c` and support deep nesting.") - [set-value](https://www.npmjs.com/package/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 (`'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 (`'a.b.c'`) paths.") ### Contributors | **Commits** | **Contributor** | | --- | --- | | 11 | [jonschlinkert](https://github.com/jonschlinkert) | | 4 | [danez](https://github.com/danez) | | 2 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) | | 1 | [TrySound](https://github.com/TrySound) | | 1 | [bluelovers](https://github.com/bluelovers) | ### Author **Jon Schlinkert** + [GitHub Profile](https://github.com/jonschlinkert) + [Twitter Profile](https://twitter.com/jonschlinkert) + [LinkedIn Profile](https://linkedin.com/in/jonschlinkert) ### License Copyright © 2021, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT License](LICENSE). *** _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on March 18, 2021._ unset-value-2.0.1/index.d.ts000066400000000000000000000001561420145235000156610ustar00rootroot00000000000000declare function unset(obj: Record, prop: string | string[]): boolean; export = unset; unset-value-2.0.1/index.js000066400000000000000000000021311420145235000154200ustar00rootroot00000000000000/*! * 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)) { throw new TypeError('expected an object.'); } var isArray = Array.isArray(prop); if (!isArray && obj.hasOwnProperty(prop)) { delete obj[prop]; return true; } if (has(obj, prop)) { var segs = isArray ? prop.slice() : prop.split('.'); var last = segs.pop(); while (segs.length && segs[segs.length - 1].slice(-1) === '\\') { last = segs.pop().slice(0, -1) + '.' + last; } while (segs.length) { prop = segs.shift(); validateKey(prop); obj = obj[prop]; } return (delete obj[last]); } return true; }; unset-value-2.0.1/package.json000066400000000000000000000027141420145235000162500ustar00rootroot00000000000000{ "name": "unset-value", "description": "Delete nested properties from an object using dot notation.", "version": "2.0.1", "homepage": "https://github.com/jonschlinkert/unset-value", "author": "Jon Schlinkert (https://github.com/jonschlinkert)", "contributors": [ " (https://github.com/wtgtybhertgeghgtwtg)", "Jon Schlinkert (http://twitter.com/jonschlinkert)" ], "repository": "jonschlinkert/unset-value", "bugs": { "url": "https://github.com/jonschlinkert/unset-value/issues" }, "license": "MIT", "files": [ "index.js", "index.d.ts" ], "main": "index.js", "types": "index.d.ts", "engines": { "node": ">=10" }, "scripts": { "test": "mocha" }, "dependencies": { "has-value": "^2.0.2", "isobject": "^4.0.0" }, "devDependencies": { "gulp-format-md": "^0.1.11", "mocha": "*", "should": "*" }, "keywords": [ "del", "delete", "key", "object", "omit", "prop", "property", "remove", "unset", "value" ], "verb": { "related": { "list": [ "get-value", "get-values", "omit-value", "put-value", "set-value", "union-value", "upsert-value" ] }, "toc": false, "layout": "default", "tasks": [ "readme" ], "plugins": [ "gulp-format-md" ], "lint": { "reflinks": true } } } unset-value-2.0.1/test.js000066400000000000000000000064771420145235000153110ustar00rootroot00000000000000/*! * unset * * Copyright (c) 2015 . * Licensed under the MIT license. */ 'use strict'; /* deps: mocha */ var assert = require('assert'); var should = require('should'); var unset = require('./'); describe('unset', function () { it('should update the given object when a property is deleted:', function () { var obj = {a: 'b'}; unset(obj, 'a'); obj.should.eql({}); }); it('should return true when a property is deleted:', function () { unset({a: 'b'}, 'a').should.eql(true); }); it('should return true when the given property does not exist:', function () { unset({a: 'b'}, 'z').should.eql(true); }); it('should delete nested values:', function () { var one = {a: {b: {c: 'd'}}}; unset(one, 'a.b'); one.should.eql({a: {}}); var two = {a: {b: {c: 'd'}}}; unset(two, 'a.b.c'); two.should.eql({a: {b: {}}}); var three = {a: {b: {c: 'd', e: 'f'}}}; unset(three, 'a.b.c'); three.should.eql({a: {b: {e: 'f'}}}); }); it('should delete...:', function () { var three = {'a.b': 'c', d: 'e'}; unset(three, 'a.b'); three.should.eql({d: 'e'}); }); it('should delete nested escaped values:', function () { var one = {a: {'b.c': 'd'}}; unset(one, 'a.b\\.c'); one.should.eql({a: {}}); var two = {'a.b.c': 'd'}; unset(two, 'a\\.b\\.c'); two.should.eql({}); var three = {'a.b': 'c', d: 'e'}; unset(three, 'a\\.b'); three.should.eql({d: 'e'}); }); it('should throw an error when invalid args are passed:', function () { (function () { unset(); }).should.throw('expected an object.'); }); }); describe('input path as array paths', function () { it('should update the given object when a property is deleted:', function () { var obj = {a: 'b'}; unset(obj, ['a']); obj.should.eql({}); }); it('should return true when a property is deleted:', function () { unset({a: 'b'}, ['a']).should.eql(true); }); it('should return true when the given property does not exist:', function () { unset({a: 'b'}, ['z']).should.eql(true); }); it('should delete nested values:', function () { var one = {a: {b: {c: 'd'}}}; unset(one, ['a', 'b']); one.should.eql({a: {}}); var two = {a: {b: {c: 'd'}}}; unset(two, ['a', 'b', 'c']); two.should.eql({a: {b: {}}}); var three = {a: {b: {c: 'd', e: 'f'}}}; unset(three, ['a', 'b', 'c']); three.should.eql({a: {b: {e: 'f'}}}); }); it('should delete...:', function () { var three = {'a.b': 'c', d: 'e'}; unset(three, ['a.b']); three.should.eql({d: 'e'}); }); it('should delete nested escaped values:', function () { var one = {a: {'b.c': 'd'}}; unset(one, ['a', 'b.c']); one.should.eql({a: {}}); var two = {'a.b.c': 'd'}; unset(two, ['a.b.c']); two.should.eql({}); var three = {'a.b': 'c', d: 'e'}; unset(three, ['a.b']); three.should.eql({d: 'e'}); }); it('should throw an error when invalid args are passed:', function () { (function () { unset(); }).should.throw('expected an object.'); }); it('should not allow unsetting unsafe values', () => { assert.throws(() => unset({}, '__proto__.toString')); assert.throws(() => unset(()=>{}, 'prototype')); assert.throws(() => unset(()=>{}, 'contructor')); }); });