Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-10 02:47:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update filterObject docs to reference pickBy (#3861)

Browse Source 
* Update `filterObject` docs to reference `pickBy`.
This commit is contained in:
Kevin Cooper
2018-07-10 09:47:19 -07:00
committed by John-David Dalton
parent ab960bdc96
commit 4851183757
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
filterObject.js
View File

@@ -3,12 +3,14 @@
* `predicate` returns truthy for. The predicate is invoked with three * `predicate` returns truthy for. The predicate is invoked with three
* arguments: (value, key, object). * arguments: (value, key, object).
* *
* If you want an object in return, consider `pickBy`.
*
* @since 5.0.0 * @since 5.0.0
* @category Object * @category Object
* @param {Object} object The object to iterate over. * @param {Object} object The object to iterate over.
* @param {Function} predicate The function invoked per iteration. * @param {Function} predicate The function invoked per iteration.
* @returns {Array} Returns the new filtered array. * @returns {Array} Returns the new filtered array.
* @see pull, pullAll, pullAllBy, pullAllWith, pullAt, remove, reject * @see pickBy, pull, pullAll, pullAllBy, pullAllWith, pullAt, remove, reject
* @example * @example
* *
* const object = { 'a': 5, 'b': 8, 'c': 10 } * const object = { 'a': 5, 'b': 8, 'c': 10 }