UNPKG

5.01 kBMarkdownView Raw
1# object.omit [![NPM version](https://img.shields.io/npm/v/object.omit.svg?style=flat)](https://www.npmjs.com/package/object.omit) [![NPM monthly downloads](https://img.shields.io/npm/dm/object.omit.svg?style=flat)](https://npmjs.org/package/object.omit) [![NPM total downloads](https://img.shields.io/npm/dt/object.omit.svg?style=flat)](https://npmjs.org/package/object.omit) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/object.omit.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/object.omit)
2
3> Return a copy of an object excluding the given key, or array of keys. Also accepts an optional filter function as the last argument.
4
5Follow this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), for updates on this project and others.
6
7## Install
8
9Install with [npm](https://www.npmjs.com/):
10
11```sh
12$ npm install --save object.omit
13```
14
15## Usage
16
17```js
18var omit = require('object.omit');
19```
20
21Pass a string `key` to omit:
22
23```js
24omit({a: 'a', b: 'b', c: 'c'}, 'a')
25//=> { b: 'b', c: 'c' }
26```
27
28Pass an array of `keys` to omit:
29
30```js
31omit({a: 'a', b: 'b', c: 'c'}, ['a', 'c'])
32//=> { b: 'b' }
33```
34
35Returns the object if no keys are passed:
36
37```js
38omit({a: 'a', b: 'b', c: 'c'})
39//=> {a: 'a', b: 'b', c: 'c'}
40```
41
42Returns an empty object if no value is passed.
43
44```js
45omit()
46//=> {}
47```
48
49### Filter function
50
51An optional filter function may be passed as the last argument, with or without keys passed on the arguments:
52
53**filter on keys**
54
55```js
56var res = omit({a: 'a', b: 'b', c: 'c'}, function (val, key) {
57 return key === 'a';
58});
59//=> {a: 'a'}
60```
61
62**filter on values**
63
64```js
65var fn = function() {};
66var obj = {a: 'a', b: 'b', c: fn};
67
68var res = omit(obj, ['a'], function (val, key) {
69 return typeof val !== 'function';
70});
71//=> {b: 'b'}
72```
73
74## About
75
76### Related projects
77
78You might also be interested in these projects:
79
80* [object.defaults](https://www.npmjs.com/package/object.defaults): Like `extend` but only copies missing properties/values to the target object. | [homepage](https://github.com/jonschlinkert/object.defaults "Like `extend` but only copies missing properties/values to the target object.")
81* [object.filter](https://www.npmjs.com/package/object.filter): Create a new object filtered to have only properties for which the callback returns true. | [homepage](https://github.com/jonschlinkert/object.filter "Create a new object filtered to have only properties for which the callback returns true.")
82* [object.pick](https://www.npmjs.com/package/object.pick): Returns a filtered copy of an object with only the specified keys, similar to `_.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.")
83* [object.pluck](https://www.npmjs.com/package/object.pluck): Like pluck from underscore / lo-dash, but returns an object composed of specified properties, with… [more](https://github.com/jonschlinkert/object.pluck) | [homepage](https://github.com/jonschlinkert/object.pluck "Like pluck from underscore / lo-dash, but returns an object composed of specified properties, with values unmodified from those of the original object.")
84* [object.reduce](https://www.npmjs.com/package/object.reduce): Reduces an object to a value that is the accumulated result of running each property… [more](https://github.com/jonschlinkert/object.reduce) | [homepage](https://github.com/jonschlinkert/object.reduce "Reduces an object to a value that is the accumulated result of running each property in the object through a callback.")
85
86### Contributing
87
88Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
89
90### Contributors
91
92| **Commits** | **Contributor** |
93| --- | --- |
94| 21 | [jonschlinkert](https://github.com/jonschlinkert) |
95| 1 | [bfred-it](https://github.com/bfred-it) |
96
97### Building docs
98
99_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
100
101To generate the readme, run the following command:
102
103```sh
104$ npm install -g verbose/verb#dev verb-generate-readme && verb
105```
106
107### Running tests
108
109Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
110
111```sh
112$ npm install && npm test
113```
114
115### Author
116
117**Jon Schlinkert**
118
119* [github/jonschlinkert](https://github.com/jonschlinkert)
120* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
121
122### License
123
124Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
125Released under the [MIT License](LICENSE).
126
127***
128
129_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 03, 2017._
\No newline at end of file