@fav/prop.set-deep

Sets a property value in property tree of an object with a property path.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
10Feb 9, 2021Nov 21, 2017Minified + gzip package size for @fav/prop.set-deep in KB

Readme

@fav/prop.set-deep NPM MIT License Build Status Build Status Coverage status

Sets a property value in property tree of an object with a property path.

"fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.

Install

To install from npm:

$ npm install --save @fav/prop.set-deep

NOTE: npm < 2.7.0 does not support scoped package, but old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/prop.set-deep/ directory manually.

Usage

For Node.js:

var setDeep = require('@fav/prop.set-deep');
var obj = { a: 1, b: { c: 3, d: 4 }, e: 5 };
setDeep(obj, ['b', 'c'], 30);
console.log(obj); // => { a: 1, b: { c: 30, d: 4 }, e: 5 }

For Web browsers:

<script src="fav.prop.omit-deep.min.js"></script>
<script>
var setDeep = fav.prop.setDeep;
var obj = { a: 1, b: { c: 3, d: 4 }, e: 5 };
setDeep(obj, ['b', 'c'], 30);
console.log(obj); // => { a: 1, b: { c: 30, d: 4 }, e: 5 }
</script>

API

setDeep(obj, propPath, value) : Void

Sets a property value in property tree of an object with a property path.

A property path is an array of keys/symbols which are passed from root to a target property in property tree of obj object. For example, the property path of c in { a: { b: { c: 1 } } } is ['a', 'b', 'c']. For a top property, a string or a symbol can be specified.

This function is targeted at all properties, which are enumerable and unenumerable, own and inherited. If target property is read only, this function does nothing and throws no error.

NOTE: All versions of Node.js allows to use a string array for getting or setting property, like obj[['a','b']] == obj['a,b']. An Symbol array is allowed as same until v4, but is not allowed on v5 and later (TypeError is thrown). To support same behaviors for all versions, this function does not allow to use an array as a property. (Thus, a property path needs to be always one dimensional array).

Parameters:

Parameter Type Description
src object A source object.
propPath Array A property path of keys and symbols.
value any A value to be set to target property.

Checked

Node.js (11〜)

Platform 11 12 13 14 15
macOS
Windows10
Linux

Node.js (4〜10)

Platform 4 5 6 7 8 9 10
macOS
Windows10
Linux

io.js (1〜3)

Platform 1 2 3
macOS
Windows10
Linux

Node.js (〜0.12)

Platform 0.8 0.9 0.10 0.11 0.12
macOS
Windows10
Linux

Web browsers

Platform Chrome Firefox Vivaldi Safari Edge IE11
macOS --
Windows10 --
Linux -- -- --

License

Copyright (C) 2017-2021 Takayuki Sato

This program is free software under MIT License. See the file LICENSE in this distribution for more details.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.