object.omit

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

$ npm i object.omit --save-dev

Usage

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()
//=> {}

Filter function

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'}

Other awesome javascript/node.js utils

object.filter: Create a new object filtered to have only properties for which the callback returns true.
object.pick: Returns a filtered copy of an object with only the specified keys, like pick from… more
object.pluck: Like pluck from underscore / lo-dash, but returns an object composed of specified properties, with… more
object.reduce: Reduces an object to a value that is the accumulated result of running each property… more
object.defaults: Like extend but only copies missing properties/values to the target object.

Runing tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

License

This file was generated by verb-cli on July 22, 2015.

2.7 KiB Raw Blame History