pick-prop
Version:
Given an object, pick a random property and return it.
60 lines (37 loc) • 2.11 kB
Markdown
# pick-prop
> Given an object, pick a random property and return it.
[](https://github.com/mock-end/pick-prop/blob/master/LICENSE)
[](https://travis-ci.org/mock-end/pick-prop)
[](https://coveralls.io/github/mock-end/pick-prop)
## Install
```
$ npm install --save pick-prop
```
## Usage
> For more use-cases see the [tests](https://github.com/mock-end/pick-prop/blob/master/test/spec/index.js)
```js
var pickProp = require('pick-prop');
// API
// - pickProp(object);
pickProp({ a: 1, b: 2, c: 3 }); // => 3
pickProp([2]); // => 2
// empty object or array
pickProp([]); // => undefined
pickProp({}); // => undefined
// others
pickProp(); // => undefined
pickProp(null); // => undefined
pickProp(1); // => undefined
pickProp('a'); // => undefined
```
## Related
- [pick-props](https://github.com/mock-end/pick-props) - Given an object, pick some random properties and return them in an array.
- [pick-key](https://github.com/mock-end/pick-key) - Given an object, pick a random key and return it.
- [pick-keys](https://github.com/mock-end/pick-keys) - Given an object, pick some random keys and return them in an array.
- [pick-pair](https://github.com/mock-end/pick-pair) - Given an object, pick a random key-value and return it in a new object.
- [pick-pairs](https://github.com/mock-end/pick-pairs) - Given an object, pick some random key-values and return it in a new object.
- [pick-item](https://github.com/mock-end/pick-item) - Given an array, pick a random element and return it.
- [pick-items](https://github.com/mock-end/pick-items) - Given an array, pick some random elements and return them in a new array.
## Contributing
Pull requests and stars are highly welcome.
For bugs and feature requests, please [create an issue](https://github.com/mock-end/pick-prop/issues/new).