For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /reference/object/pick.md.

pick es-toolkit

Returns a new object containing only the properties corresponding to the specified keys.

const result = pick(obj, keys);

Usage

pick(obj, keys)

Use pick when you want to select only specific keys from an object. It returns a new object containing only the properties corresponding to the specified keys.

import { pick } from 'es-toolkit/object';

// Select specific keys
const obj = { a: 1, b: 2, c: 3, d: 4 };
const result = pick(obj, ['a', 'c']);
// result is { a: 1, c: 3 }

// Non-existent keys are ignored
const safe = pick(obj, ['a', 'nonexistent']);
// safe is { a: 1 }

// Can be used with nested objects
const nested = {
  user: { name: 'John', age: 30 },
  posts: ['post1', 'post2'],
  settings: { theme: 'dark' },
};
const picked = pick(nested, ['user', 'settings']);
// picked is { user: { name: 'John', age: 30 }, settings: { theme: 'dark' } }

Parameters

objT extends Record<string, any>required

The object to select properties from.

keysreadonly K[]required

An array of keys to select from the object.

Returns

A new object containing only the properties corresponding to the specified keys.

Pick<T, K>
Source: es-toolkit

Re-exported verbatim from es-toolkit. Implementation, edge cases, and performance behavior are owned upstream. This page mirrors the documentation at the pinned version; the linked source is authoritative.