es-toolkit/docs/reference/object/pickBy.md

34 lines
1.0 KiB
Markdown
Raw Normal View History

2024-04-25 14:56:13 +03:00
# pickBy
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
2024-04-25 14:56:13 +03:00
includes only the properties for which the predicate function returns true.
## Signature
```typescript
function pickBy<T extends Record<string, any>>(
obj: T,
shouldPick: (value: T[keyof T], key: keyof T) => boolean
): Partial<T>;
2024-04-25 14:56:13 +03:00
```
### Parameters
2024-04-25 14:56:13 +03:00
- `obj` (`T`): The object to pick properties from.
- `shouldPick` (`(value: T[keyof T], key: keyof T) => boolean`): 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.
2024-04-25 14:56:13 +03:00
### Returns
(`Partial<T>`): A new object with the properties that satisfy the predicate function.
## Examples
```typescript
const obj = { a: 1, b: 'pick', c: 3 };
const shouldPick = (value, key) => typeof value === 'string';
const result = pickBy(obj, shouldPick);
// result will be { b: 'pick' }
```