@fav/prop.omit-deep

Creates a new plain object and copy child and descendant properties of a source object except specified deeply.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Aug 25, 2018Feb 9, 2018Minified + gzip package size for @fav/prop.omit-deep in KB

Readme

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

Creates a new plain object and copies child and descendant properties of a source object except specified deeply.

"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.omit-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.omit-deep/ directory manually.

Usage

For Node.js:

var omitDeep = require('@fav/prop.omit-deep');
omitDeep({ a: 1, b: { c: 3, d: 4 }, e: 5 }, [['b', 'c'], 'e']); // => { a: 1, b: { d: 4 } }

For Web browsers:

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

API

omitDeep(src, omittedPropPaths) : object

Creates a new plain object and copies child and descendant enumerable own properties (keys and symbols) of src object deeply, but the properties which are included in omittedPropPaths are omitted.

omittedPropPaths is an array of property paths. A property path is an array of keys/symbols which are passed from root to a target property in property tree of src object. For example, the property path of c in { a: { b: { c: 1 } } } => ['a', 'b', 'c'].

For a top property, a string key or a symbol can be specified. For omitting one property, a prperty path can be specified.

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.
omittedPropPaths Array Property paths of keys and symbols to be omitted.

Returns:

A plain object which is copied properties deeply except specified.

Checked

Node.js (4〜)

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-2018 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.