# @delucis/reading-data-pick

> lodash.pick plugin for @delucis/reading-data.

Latest version **0.1.0** (published 2017-08-29) · GPL-3.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @delucis/reading-data-pick
pnpm add @delucis/reading-data-pick
yarn add @delucis/reading-data-pick
bun add @delucis/reading-data-pick
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2017-08-29 |
| First published | 2017-08-29 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Chris Swithinbank |
| Maintainers | delucis |

## Links

- npm: https://www.npmjs.com/package/@delucis/reading-data-pick
- Repository: https://github.com/delucis/reading-data-pick
- Homepage: https://github.com/delucis/reading-data-pick#readme
- Issues: https://github.com/delucis/reading-data-pick/issues
- npm.io page: https://npm.io/package/@delucis/reading-data-pick

## Dependencies (1)

- [lodash.pick](https://npm.io/package/lodash.pick.md) ^4.4.0

## Recent versions

- 0.1.0 (latest) — 2017-08-29

## README

# @delucis/reading-data-pick

[![Build Status](https://travis-ci.org/delucis/reading-data-pick.svg?branch=master)](https://travis-ci.org/delucis/reading-data-pick)
[![Coverage Status](https://coveralls.io/repos/github/delucis/reading-data-pick/badge.svg?branch=master)](https://coveralls.io/github/delucis/reading-data-pick?branch=master)
[![npm (scoped)](https://img.shields.io/npm/v/@delucis/reading-data-pick.svg)](https://www.npmjs.com/package/@delucis/reading-data-pick)

A plugin for [`@delucis/reading-data`](https://github.com/delucis/reading-data)
that allows easy use of [`lodash.pick`][592bfd42].

  [592bfd42]: https://www.npmjs.com/package/lodash.pick "lodash.pick NPM package"


## Installation

```sh
npm install --save @delucis/reading-data-pick
```


## Usage

```js
const RD = require('@delucis/reading-data')
const PICK = require('@delucis/reading-data-pick')

RD.preloadData({
  myArticle: {
    text: 'This is a short article that is well worth reading.',
    meta: 'This is some superfluous metadata we’d rather not include'
  }
})

RD.use(PICK, {
  scope: 'myArticle',
  pick: 'text'
})

RD.run().then((res) => {
  console.log(res.data.myArticle)
  // logs: { text: 'This is a short article that is well worth reading.' }
})
```


## Options

name        | type               | default       | description
------------|--------------------|---------------|------------------------------
`hooks`     | `String`, `Object` | `'process'`   | The `reading-data` hook that on which the scope should be picked. Can be scoped by passing an object with scopes as keys, hooks as values.
`pick`      | `String`, `Array`  |               | The property/properties to be picked (i.e. included) from the original data.
`scope`     | `String`, `Array`  | `'pick'` | The scope under which `reading-data` will store this plugin’s data.

---
_Source: https://npm.io/package/@delucis/reading-data-pick · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._