From 48511837573d99138fc43b7e9f04eea7b01839fe Mon Sep 17 00:00:00 2001 From: Kevin Cooper Date: Tue, 10 Jul 2018 09:47:19 -0700 Subject: [PATCH] Update `filterObject` docs to reference `pickBy` (#3861) * Update `filterObject` docs to reference `pickBy`. --- filterObject.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/filterObject.js b/filterObject.js index 71c017e8c..08631f571 100644 --- a/filterObject.js +++ b/filterObject.js @@ -3,12 +3,14 @@ * `predicate` returns truthy for. The predicate is invoked with three * arguments: (value, key, object). * + * If you want an object in return, consider `pickBy`. + * * @since 5.0.0 * @category Object * @param {Object} object The object to iterate over. * @param {Function} predicate The function invoked per iteration. * @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 * * const object = { 'a': 5, 'b': 8, 'c': 10 }