|
||
---|---|---|
.. | ||
docs | ||
lib | ||
package.json | ||
README.md |
omit
Return a partial object copy excluding specified keys.
Usage
var omit = require( '@stdlib/utils/omit' );
omit( obj, keys )
Returns a partial copy of an object
, which excludes specified keys
.
var obj1 = {
'a': 1,
'b': 2,
'c': 3
};
var obj2 = omit( obj1, 'b' );
// returns { 'a': 1, 'c': 3 }
var obj3 = omit( obj1, [ 'b', 'c' ] );
// returns { 'a': 1 }
The function ignores non-existent and inherited keys.
var obj1 = {
'a': 1,
'b': 2,
'c': 3
};
var obj2 = omit( obj1, 'd' );
// returns { 'a': 1, 'b': 2, 'c': 3 }
Notes
- The function returns a shallow copy.
- The function only copies own properties. Hence, the function never copies inherited properties.
Examples
var omit = require( '@stdlib/utils/omit' );
var obj1 = {
'a': 1,
'b': 2,
'c': 3,
'd': 4,
'e': 5
};
var obj2 = omit( obj1, [ 'b', 'c', 'e' ] );
// returns { 'a': 1, 'd': 4 }