pick

object

Creates an object composed of the picked object properties.

Installation

Import

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

Source Code

Implementation

/**
 * Creates an object composed of the picked object properties.
 *
 * @param object - The source object.
 * @param paths - The property paths to pick.
 * @returns Returns the new object.
 *
 * @example
 * ```ts
 * const object = { 'a': 1, 'b': '2', 'c': 3 };
 * pick(object, ['a', 'c']); // { 'a': 1, 'c': 3 }
 * ```
 */
export function pick<T extends Record<string, unknown>>(
  object: T,
  paths: readonly (string | readonly (string | number)[])[]
): Partial<T> {
  const pathSet = new Set(
    paths.map((path) => (Array.isArray(path) ? path.join('.') : String(path)))
  );
  const result: Partial<T> = {};

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

  return result;
}

Example

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

const object = { 'a': 1, 'b': '2', 'c': 3 };
pick(object, ['a', 'c']); // { '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.