www.aleph1.co.uk Git - yaffs-website/blob - node_modules/object.omit/README.md

   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
   5 ## Install
   6
   7 Install with [npm](https://www.npmjs.com/):
   8
   9 ```sh
  10 $ npm install --save object.omit
  11 ```
  12
  13 ## Usage
  14
  15 ```js
  16 var omit = require('object.omit');
  17 ```
  18
  19 Pass a string `key` to omit:
  20
  21 ```js
  22 omit({a: 'a', b: 'b', c: 'c'}, 'a')
  23 //=> { b: 'b', c: 'c' }
  24 ```
  25
  26 Pass an array of `keys` to omit:
  27
  28 ```js
  29 omit({a: 'a', b: 'b', c: 'c'}, ['a', 'c'])
  30 //=> { b: 'b' }
  31 ```
  32
  33 Returns the object if no keys are passed:
  34
  35 ```js
  36 omit({a: 'a', b: 'b', c: 'c'})
  37 //=> {a: 'a', b: 'b', c: 'c'}
  38 ```
  39
  40 Returns an empty object if no value is passed.
  41
  42 ```js
  43 omit()
  44 //=> {}
  45 ```
  46
  47 ### Filter function
  48
  49 An optional filter function may be passed as the last argument, with or without keys passed on the arguments:
  50
  51 **filter on keys**
  52
  53 ```js
  54 var res = omit({a: 'a', b: 'b', c: 'c'}, function (val, key) {
  55   return key === 'a';
  56 });
  57 //=> {a: 'a'}
  58 ```
  59
  60 **filter on values**
  61
  62 ```js
  63 var fn = function() {};
  64 var obj = {a: 'a', b: 'b', c: fn};
  65
  66 var res = omit(obj, ['a'], function (val, key) {
  67   return typeof val !== 'function';
  68 });
  69 //=> {b: 'b'}
  70 ```
  71
  72 ## About
  73
  74 ### Related projects
  75
  76 * [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.")
  77 * [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.")
  78 * [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.")
  79 * [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.")
  80 * [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.")
  81
  82 ### Contributing
  83
  84 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  85
  86 ### Building docs
  87
  88 _(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
  89
  90 To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
  91
  92 ```sh
  93 $ npm install -g verb verb-generate-readme && verb
  94 ```
  95
  96 ### Running tests
  97
  98 Install dev dependencies:
  99
 100 ```sh
 101 $ npm install -d && npm test
 102 ```
 103
 104 ### Author
 105
 106 **Jon Schlinkert**
 107
 108 * [github/jonschlinkert](https://github.com/jonschlinkert)
 109 * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
 110
 111 ### License
 112
 113 Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
 114 Released under the [MIT license](https://github.com/jonschlinkert/object.omit/blob/master/LICENSE).
 115
 116 ***
 117
 118 _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on October 27, 2016._