pick-items

Given an array, pick some random elements and return them in a new array.

Usage no npm install needed!

<script type="module">
  import pickItems from 'https://cdn.skypack.dev/pick-items';
</script>

README

pick-items

Given an array, pick some random elements and return them in a new array.

MIT License

build:? coverage:?

Install

$ npm install --save pick-items 

Usage

For more use-cases see the tests

var pickItems = require('pick-items');

// API
// - pickItems(array[, count/options])

By default omit the quantity to retrieve a set with a random length:

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

Can optionally specify the quantity to retrieve:

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

Can optionally shuffle the new array or not:

pickItems([1, 2, 3, 4, 5], { count: 3, shuffled: true });
// => [3, 1, 5]

Related

  • pick-item - Given an array, pick a random element 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-key - Given an object, pick a random key and return it.
  • pick-keys - Given an object, pick some random keys 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.

Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please create an issue.