@lavadrop/pick/README.md

Creates an object composed of the picked object properties.

# @lavadrop/pick

[![npm license](http://img.shields.io/npm/l/@lavadrop/pick.svg)](https://www.npmjs.org/package/@lavadrop/pick)
[![Travis Build Status](https://img.shields.io/travis/jedmao/lavadrop.svg)](https://travis-ci.org/jedmao/lavadrop)
[![codecov](https://codecov.io/gh/jedmao/lavadrop/branch/master/graph/badge.svg)](https://codecov.io/gh/jedmao/lavadrop)
[![Try @lavadrop/pick on RunKit](https://badge.runkitcdn.com/@lavadrop/pick.svg)](https://npm.runkit.com/@lavadrop/pick)

Part of a [library](../../../../) of zero-dependency npm modules that do just
one thing.

- 100% [TypeScript](http://www.typescriptlang.org/) support.
- It's not a party without [`Lavadrop`](../../../../)!

[![npm](https://nodei.co/npm/@lavadrop/pick.svg?downloads=true)](https://nodei.co/npm/@lavadrop/pick/)

min + gzip | 99 bytes

[source](https://github.com/jedmao/lavadrop/blob/master/src/packages/pick/pick.ts)

Creates an object composed of the picked `object` properties.

## Usage

```ts
import pick from '@lavadrop/pick'

const obj = { a: 1, b: 2, c: 3 }
pick(obj, 'a', 'c')
// => { a: 1, c: 3 }
```

## Parameters

| Name     | Type  | Description                 |
| :------- | :---- | :-------------------------- |
| `object` | `T`   | The source object.          |
| `paths`  | `K[]` | The property paths to pick. |

### Type parameters

| Name | Constraint |
| :--- | :--------- |
| `T`  | `object`   |
| `K`  | `keyof T`  |

## Returns

A new object composed of the picked `object` properties.

### Return type

```ts
Partial<Pick<T, K>>
```