pickBy

Import from @varavel/vdl-plugin-sdk/utils/objects.

function pickBy<T>(obj, shouldPick): Partial<T>;

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.

Type Parameters

Type Parameter	Description
`T` extends `Record`\<`string`, `any`>	The type of object.

Parameters

Parameter	Type	Description
`obj`	`T`	The object to pick properties from.
`shouldPick`	(`value`, `key`) => `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.

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' }