pick

Creates a new object containing only the specified keys from the source object. Supports dot notation for selecting nested keys.

Import

import { pick } from "1o1-utils";

import { pick } from "1o1-utils/pick";

Signature

function pick<T extends Record<string, unknown>>({ obj, keys }: PickParams<T>): Record<string, unknown>

Parameters

Name	Type	Required	Description
obj	T	Yes	The source object
keys	(keyof T | string)[]	Yes	Keys to include (supports dot notation for nested keys)

Returns

Record<string, unknown> — A new object with only the specified keys.

Examples

pick({ obj: { a: 1, b: 2, c: 3 }, keys: ["a", "c"] });
// => { a: 1, c: 3 }

// Nested keys with dot notation
pick({ obj: { a: 1, b: { x: 10, y: 20 } }, keys: ["a", "b.x"] });
// => { a: 1, b: { x: 10 } }

Edge Cases

• Throws if obj is not an object.
• Throws if keys is not an array.
• Supports nested key selection via dot notation.
• Missing keys are silently skipped.

Also known as

select keys, extract properties, subset object, pluck

Prompt suggestion

I'm using 1o1-utils (npm: https://www.npmjs.com/package/1o1-utils, GitHub: https://github.com/pedrotroccoli/1o1-utils, LLM context: https://pedrotroccoli.github.io/1o1-utils/llms.txt). Show me how to use pick to extract only needed fields from an API response