23 lines
1.1 KiB
TypeScript
23 lines
1.1 KiB
TypeScript
/**
|
|
* Creates a new object composed of the properties that satisfy the predicate function.
|
|
*
|
|
* This function takes an object and a predicate function, and returns a new object that
|
|
* includes only the properties for which the predicate function returns true.
|
|
*
|
|
* @template T - The type of object.
|
|
* @param {T} obj - The object to pick properties from.
|
|
* @param {(value: T[keyof T], key: keyof T) => boolean} shouldPick - A predicate function that determines
|
|
* whether a property should be picked. It takes the property's key and value as arguments and returns `true`
|
|
* if the property should be picked, and `false` otherwise.
|
|
* @returns {Partial<T>} A new object with the properties that satisfy the predicate function.
|
|
*
|
|
* @example
|
|
* const obj = { a: 1, b: 'pick', c: 3 };
|
|
* const shouldPick = (value) => typeof value === 'string';
|
|
* const result = pickBy(obj, shouldPick);
|
|
* // result will be { b: 'pick' }
|
|
*/
|
|
declare function pickBy<T extends Record<string, any>>(obj: T, shouldPick: (value: T[keyof T], key: keyof T) => boolean): Partial<T>;
|
|
|
|
export { pickBy };
|