Skip to content

pick

The pick() method creates a new object by selecting only certain properties.

Interactive example

Syntax

Classic signature

typescript
function pick<
	GenericInput extends object,
	GenericPickValue extends Partial<Record<keyof GenericInput, boolean>> | readonly (keyof GenericInput)[]
>(
	input: GenericInput,
	pickValue: GenericPickValue
): SimplifyTopLevel<Pick<GenericInput, ...>>

Curried signature

typescript
function pick<
	GenericInput extends object,
	GenericPickValue extends Partial<Record<keyof GenericInput, boolean>> | readonly (keyof GenericInput)[]
>(
	pickValue: GenericPickValue
): (input: GenericInput) => SimplifyTopLevel<Pick<GenericInput, ...>>

Parameters

  • input: The source object.
  • pickValue: The keys to keep (array of keys or object with boolean values).

Return value

A new object containing only the selected properties.

See also

  • omit - Creates an object by excluding certain properties

Released under the MIT license.