pickBy

object

Creates an object composed of the object properties predicate returns truthy for.

Installation

Import

import { pickBy } from '@tulx/utils';

Source Code

Implementation

/**
 * Creates an object composed of the object properties predicate returns truthy for.
 *
 * @param object - The source object.
 * @param predicate - The function invoked per property.
 * @returns Returns the new object.
 *
 * @example
 * ```ts
 * const object = { 'a': 1, 'b': '2', 'c': 3 };
 * pickBy(object, (value) => typeof value === 'number'); // { 'a': 1, 'c': 3 }
 * ```
 */
export function pickBy<T extends Record<string, unknown>>(
  object: T,
  predicate: (value: unknown, key: string) => boolean
): Partial<T> {
  const result: Partial<T> = {};

  for (const key in object) {
    if (
      Object.prototype.hasOwnProperty.call(object, key) &&
      predicate(object[key], key)
    ) {
      result[key] = object[key];
    }
  }

  return result;
}

Example

import { pickBy } from '@tulx/utils';

const object = { 'a': 1, 'b': '2', 'c': 3 };
pickBy(object, (value) => typeof value === 'number'); // { 'a': 1, 'c': 3 }

Related Functions

assign

Assigns own enumerable string keyed properties of source objects to the destination object.

assignIn

This method is like assign except that it iterates over own and inherited source properties.

assignInWith

This method is like assignIn except that it accepts customizer which is invoked to produce the assigned values.

assignWith

This method is like assign except that it accepts customizer which is invoked to produce the assigned values.

Creates an array of values corresponding to paths of object.

create

Creates an object that inherits from the prototype object.