feat: add pickBy

cdn/radash.esm.js

@@ -695,6 +695,14 @@ const pick = (obj, keys2) => {
     return acc;
   }, {});
 };
+const pickBy = (obj, predicate = () => true) => {
+  if (!obj)
+    return {};
+  return pick(
+    obj,
+    Object.keys(obj).filter((key) => predicate(obj[key]))
+  );
+};
 const omit = (obj, keys2) => {
   if (!obj)
     return {};
@@ -937,4 +945,4 @@ const trim = (str, charsToTrim = " ") => {
   return str.replace(regex, "");
 };
 
-export { all, alphabetical, assign, boil, callable, camel, capitalize, chain, clone, cluster, compose, construct, counting, crush, dash, debounce, defer, diff, draw, first, flat, fork, get, group, guard, inRange, intersects, invert, isArray, isDate, isEmpty, isEqual, isFloat, isFunction, isInt, isNumber, isObject, isPrimitive, isPromise, isString, isSymbol, iterate, keys, last, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, max, memo, merge, min, objectify, omit, parallel, partial, partob, pascal, pick, proxied, random, range, reduce, replace, replaceOrAppend, retry, select, series, set, shake, shift, shuffle, sift, sleep, snake, sort, sum, template, throttle, title, toFloat, toInt, toggle, trim, tryit as try, tryit, uid, unique, upperize, zip, zipToObject };
+export { all, alphabetical, assign, boil, callable, camel, capitalize, chain, clone, cluster, compose, construct, counting, crush, dash, debounce, defer, diff, draw, first, flat, fork, get, group, guard, inRange, intersects, invert, isArray, isDate, isEmpty, isEqual, isFloat, isFunction, isInt, isNumber, isObject, isPrimitive, isPromise, isString, isSymbol, iterate, keys, last, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, max, memo, merge, min, objectify, omit, parallel, partial, partob, pascal, pick, pickBy, proxied, random, range, reduce, replace, replaceOrAppend, retry, select, series, set, shake, shift, shuffle, sift, sleep, snake, sort, sum, template, throttle, title, toFloat, toInt, toggle, trim, tryit as try, tryit, uid, unique, upperize, zip, zipToObject };

cdn/radash.js

@@ -698,6 +698,14 @@ var radash = (function (exports) {
       return acc;
     }, {});
   };
+  const pickBy = (obj, predicate = () => true) => {
+    if (!obj)
+      return {};
+    return pick(
+      obj,
+      Object.keys(obj).filter((key) => predicate(obj[key]))
+    );
+  };
   const omit = (obj, keys2) => {
     if (!obj)
       return {};
@@ -1002,6 +1010,7 @@ var radash = (function (exports) {
   exports.partob = partob;
   exports.pascal = pascal;
   exports.pick = pick;
+  exports.pickBy = pickBy;
   exports.proxied = proxied;
   exports.random = random;
   exports.range = range;

docs/object/pick-by.mdx

@@ -0,0 +1,22 @@
+---
+title: pickBy
+description: Pick only the desired attributes from an object
+group: Object
+---
+
+## Basic usage
+
+Given an object and an identity function, returns a new object with only the values which makes identity returns true.
+
+```ts
+import { pickBy } from 'radash'
+
+const fish = {
+  name: 'Bass',
+  weight: 8,
+  source: 'lake',
+  barckish: false
+}
+
+pick(fish, v => v === 8) // => { weight }
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "radash",
-  "version": "12.1.0",
+  "version": "12.2.0",
   "description": "Functional utility library - modern, simple, typed, powerful",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",

src/index.ts

@@ -69,6 +69,7 @@ export {
   mapValues,
   omit,
   pick,
+  pickBy,
   set,
   shake,
   upperize

src/object.ts

@@ -181,6 +181,24 @@ export const pick = <T extends object, TKeys extends keyof T>(
   }, {} as Pick<T, TKeys>)
 }
 
+/**
+ * Picks properties of an object based on a predicate function.
+ *
+ * @param {T} obj - The object from which to pick properties.
+ * @param {function} predicate - The function used to filter the object's properties.
+ * @return {object} A new object with properties picked based on the predicate.
+ */
+export const pickBy = <T extends object, TKeys extends keyof T>(
+  obj: T,
+  predicate: (value: T[TKeys]) => boolean = () => true
+): Pick<T, TKeys> => {
+  if (!obj) return {} as Pick<T, TKeys>
+  return pick(
+    obj,
+    (Object.keys(obj) as TKeys[]).filter(key => predicate(obj[key]))
+  )
+}
+
 /**
  * Omit a list of properties from an object
  * returning a new object with the properties

src/tests/async.test.ts

@@ -2,6 +2,11 @@ import { assert } from 'chai'
 import * as _ from '..'
 import { AggregateError } from '../async'
 
+// fix error of calling useFakeTimers on nodejs version v20.12.1 https://stackoverflow.com/a/77694958/5131623
+// Object.defineProperty(global, 'performance', {
+//   writable: true
+// })
+
 describe('async module', () => {
   beforeEach(() => jest.useFakeTimers({ advanceTimers: true }))
 

src/tests/object.test.ts

@@ -282,6 +282,23 @@ describe('object module', () => {
     })
   })
 
+  describe('pickBy function', () => {
+    test('handles null input', () => {
+      const result = _.pickBy(null as unknown as Record<string, unknown>)
+      assert.deepEqual(result, {})
+    })
+
+    test('handles no identity function', () => {
+      const result = _.pickBy({ a: 2 })
+      assert.deepEqual(result, { a: 2 })
+    })
+
+    test('returns picked properties only', () => {
+      const result = _.pickBy({ a: 1, b: 2, c: 3, d: 4 }, v => v % 2 === 0)
+      assert.deepEqual(result, { b: 2, d: 4 } as any)
+    })
+  })
+
   describe('omit function', () => {
     const person = {
       name: 'jay',