Return a copy of an object excluding the given key, or array of keys. Also accepts an optional filter function as the last argument.
Install with npm:
$ npm install --save object.omit
var omit = require('object.omit');
Pass a string key
to omit:
omit({a: 'a', b: 'b', c: 'c'}, 'a') //=> { b: 'b', c: 'c' }
Pass an array of keys
to omit:
omit({a: 'a', b: 'b', c: 'c'}, ['a', 'c']) //=> { b: 'b' }
Returns the object if no keys are passed:
omit({a: 'a', b: 'b', c: 'c'}) //=> {a: 'a', b: 'b', c: 'c'}
Returns an empty object if no value is passed.
omit() //=> {}
An optional filter function may be passed as the last argument, with or without keys passed on the arguments:
filter on keys
var res = omit({a: 'a', b: 'b', c: 'c'}, function (val, key) { return key === 'a'; }); //=> {a: 'a'}
filter on values
var fn = function() {}; var obj = {a: 'a', b: 'b', c: fn}; var res = omit(obj, ['a'], function (val, key) { return typeof val !== 'function'; }); //=> {b: 'b'}
extend
but only copies missing properties/values to the target object. | homepage_.pick… [more](https://github.com/jonschlinkert/object.pick) | [homepage](https://github.com/jonschlinkert/object.pick "Returns a filtered copy of an object with only the specified keys, similar to
_.pick` from lodash / underscore.")Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verb
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.2.0, on October 27, 2016.