https://github.com/damonoehlman/omit

Efficient ommission of object data based on keys, values and evaluator functions
https://github.com/damonoehlman/omit

Last synced: 7 days ago
JSON representation

Efficient ommission of object data based on keys, values and evaluator functions

• Host: GitHub
• URL: https://github.com/damonoehlman/omit
• Owner: DamonOehlman
• Created: 2015-03-16T09:21:53.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-02T10:08:24.000Z (almost 9 years ago)
• Last Synced: 2024-10-25T20:35:39.845Z (21 days ago)
• Language: JavaScript
• Size: 18.6 KB
• Stars: 17
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# omit

Remove values from an object (or an array of objects) based on key, value or

an evaluator function.

[![NPM](https://nodei.co/npm/omit.png)](https://nodei.co/npm/omit/)

[![Build Status](https://api.travis-ci.org/DamonOehlman/omit.svg?branch=master)](https://travis-ci.org/DamonOehlman/omit) [![bitHound Score](https://www.bithound.io/github/DamonOehlman/omit/badges/score.svg)](https://www.bithound.io/github/DamonOehlman/omit) 

## Example Usage

Shown below is a simple example of how to omit a particular key from an object:

```js

var omit = require('omit');

var someObject = {id: 101, color: 'blue'};

console.log(omit(['id'], someObject));

```

Our next example demonstrates how `omit` supports partial execution and can be

used to map over an array and strip keys out of objects in that array:

```js

var books = require('omit/test/sampledata/tolkien.json');

var omit = require('omit');

var REJECTED_KEYS = ['authors', 'created', 'last_modified'];

// log an array of the entries with the authors and created keys omitted

console.log(books.entries.map(omit(REJECTED_KEYS)));

```

## License(s)

### MIT

Copyright (c) 2015 Damon Oehlman 

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

'Software'), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.