lodash-pickdeep

lodash-pickDeep

A lodash mixin to add a pickDeep function.

Install

$ npm install --save lodash-pickdeep

Usage

Using it as a lodash mixin

var _ = require('lodash');
var pickDeep = require('lodash-pickdeep');

_.mixin( { pickDeep: pickDeep }, { chain: true } );

_.pickDeep( { a: { b: { c: 'foo', d: 'bar', e: { f: 'baz' } } } }, [ 'a.b.c', 'a.b.e' ] );
// =>  { a: { b: { c: 'foo', e: { f: 'baz' } } } }

Using it on its own

var pickDeep = require('lodash-pickdeep');

pickDeep( { a: { b: { c: 'foo', d: 'bar', e: { f: 'baz' } } } }, [ 'a.b.c', 'a.b.e' ] );
// =>  { a: { b: { c: 'foo', e: { f: 'baz' } } } }

API Documentation

_.pickDeep(object, [props])

Creates an object composed of the picked object properties, which may contain deep property identifiers.

Arguments

1. object (Object): The source object.
2. [props] (...(string|string[]): The property identifiers to pick, specified individually or in arrays.

Returns

(Object): Returns the new object.

License

Copyright (c) 2016, James M. Greene (MIT License)