# plucker

> Pluck nested properties from an object

Latest version **0.0.0** (published 2014-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install plucker
pnpm add plucker
yarn add plucker
bun add plucker
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2014-03-20 |
| First published | 2014-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 21 |
| Author | Hugh Kennedy |
| Maintainers | hughsk |
| Keywords | pluck, key, nested, property, object, get |

## Links

- npm: https://www.npmjs.com/package/plucker
- Repository: https://github.com/hughsk/plucker
- Homepage: http://hughsk.github.io/plucker
- Issues: https://github.com/hughsk/plucker/issues
- npm.io page: https://npm.io/package/plucker

## Recent versions

- 0.0.0 (latest) — 2014-03-20

## README

# plucker [![Flattr this!](https://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=hughskennedy&url=http://github.com/hughsk/plucker&title=plucker&description=hughsk/plucker%20on%20GitHub&language=en_GB&tags=flattr,github,javascript&category=software)[![experimental](http://hughsk.github.io/stability-badges/dist/experimental.svg)](http://github.com/hughsk/stability-badges) #

Pluck nested properties from an object.

## Usage ##

[![plucker](https://nodei.co/npm/plucker.png?mini=true)](https://nodei.co/npm/plucker)

### pluck = plucker(path) ###

Given a dot-delimted property `path`, returns a plucking function.

You can also pass in an array of string keys, in case you want to avoid
splitting a key which is intended to have dots in it.

### pluck(object) ###

Pass this function an object to pluck the nested value from it.

To pluck values from an array, you can simply use it with `[].map`, like so:

``` javascript
var pluck = require('plucker')
var array = require('./data.json')

return array.map(
  pluck('some.nested.value')
)
```

### plucker(path, object) ###

Shorthand for `plucker(path)(object)`.

## License ##

MIT. See [LICENSE.md](http://github.com/hughsk/plucker/blob/master/LICENSE.md) for details.

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