README

pick-util

Return a copy of the object only containing the whitelisted properties. Alternatively accepts a predicate indicating which keys to pick.

Inspired by _.pick. 😄

Install

Install with npm

$ npm install pick-util

Or unpkg

<script src="https://unpkg.com/pick-util@1.1.2/umd/index.js" />

Check out the unit tests on CodePen.

Usage

const pick = require('pick-util');

pick({ 'a': 1, 'b': '2', 'c': 3 }, ['a', 'c']);
//=> { 'a': 1, 'c': 3 }

pick({ name: 'moe', age: 50, userid: 'moe1' }, 'name', 'age');
//=> { name: 'moe', age: 50 }

const isNumber = obj => toString.call(obj) === '[object Number]';

pick({ name: 'moe', age: 50, userid: 'moe1' }, (value) => isNumber(value));
//=> { age: 50 }

Like us a lot? Help others know why you like us! Review this package on pkgreview.dev	➡

API

pick(object, *keys)

object

Type: object
Default: none

The object to filter.

keys

Type: array or comma separated list of string values or function
Default: none

Keys for the picked properties. Or a predicate indicating which keys to pick.

License

MIT

Usage no npm install needed!