UNPKG

pick-key

Version:

Given an object, pick a random key and return it.

github.com/mock-end/pick-key

mock-end/pick-key

54 lines (35 loc) • 2.06 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# pick-key > Given an object, pick a random key and return it. [![MIT License](https://img.shields.io/badge/license-MIT_License-green.svg?style=flat-square)](https://github.com/mock-end/pick-key/blob/master/LICENSE) [![build:?](https://img.shields.io/travis/mock-end/pick-key/master.svg?style=flat-square)](https://travis-ci.org/mock-end/pick-key) [![coverage:?](https://img.shields.io/coveralls/mock-end/pick-key/master.svg?style=flat-square)](https://coveralls.io/github/mock-end/pick-key) ## Install ``` $ npm install --save pick-key ``` ## Usage > For more use-cases see the [tests](https://github.com/mock-end/pick-key/blob/master/test/spec/index.js) ```js var pickKey = require('pick-key'); // API // - pickKey(object); pickKey({ a: 1, b: 1, c: 1 }); // => 'c' pickKey([2]); // => '0' pickKey(); // => undefined pickKey(null); // => undefined pickKey([]); // => undefined pickKey({}); // => undefined pickKey(1); // => undefined pickKey('a'); // => undefined ``` ## Related - [pick-keys](https://github.com/mock-end/pick-keys) - Given an object, pick some random keys and return them in an array. - [pick-prop](https://github.com/mock-end/pick-prop) - Given an object, pick a random property and return it. - [pick-props](https://github.com/mock-end/pick-props) - Given an object, pick some random properties 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-key/issues/new).