object-filters

Filter object by keys

Usage no npm install needed!

<script type="module">
  import objectFilters from 'https://cdn.skypack.dev/object-filters';
</script>

README

Build Status Coverage Status MIT Licence

object-filters

Filter object by keys. For node.js 6.x or higher

install

npm i --save object-filters

usage

import filters from 'object-filters'

// add filters as prototype to use in all objects
Object.prototype.filters = filters

const obj = {
  firstname: 'John',
  lastname: 'Snow',
  email: 'iknownothing@snow.com',
  address: {
    castle: 'Black',
    region: 'North',
  }
}

// return a new object, without alter previous obj
const filtered = obj.filters('firstname lastname')

// filtered is now
{
  firstname: 'John',
  lastname: 'Snow',
}

The method filters works with:

// strings separated by space
obj.filters('firstname lastname')
// array of strings
obj.filters(['firstname', 'lastname'])
// negative strings
obj.filters('-email -address') // or obj.filters(['-email', '-address'])
// nested object
obj.filters('firstname lastname address.castle')