Skip to content

mock-end/pick-keys

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pick-keys

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

MIT License

build:? coverage:?

Install

$ npm install --save pick-keys 

Usage

For more use-cases see the tests

var pickKeys = require('pick-keys');

// API
// - pickKeys(object);
// - pickKeys(object, count);

pickKeys({ a: 1, b: 1, c: 1 });
// => ['a', 'c']

pickKeys({ a: 1, b: 1, c: 1 }, 1);
// => ['b']

pickKeys({ a: 1, b: 1, c: 1 }, 0);
// => []

pickKeys([1, 2, 3, 4, 5]);
// => ['1', '3', '4']


// others
pickKeys();      // => []
pickKeys(null);  // => []
pickKeys(1);     // => []
pickKeys('abc'); // => []
pickKeys({});    // => []
pickKeys([]);    // => []

Related

  • pick-key - Given an object, pick a random key and return it.
  • pick-prop - Given an object, pick a random property and return it.
  • pick-props - Given an object, pick some random properties and return them in an array.
  • pick-pair - Given an object, pick a random key-value and return it in a new object.
  • pick-pairs - Given an object, pick some random key-values and return it in a new object.
  • pick-item - Given an array, pick a random element and return it.
  • 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.

About

Randomly sampling some keys from an object.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published