pick-some

A utility to pick random elements from an array

Usage no npm install needed!

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

README

Build Status License: MIT

pick-some

Simple utility to pick, select, choose random items from an array. Items can be chosen uniquely and/or sequentially.

api

pickSome(amount: number, [options: object], arr: array);

options = { unique: boolean, sequential: boolean }

example

const { pickSome } = require('pick-some');

// basic use
pickSome(3, [1,2,3,4,5]) // => [2,5,5]

// unqiue items only
pickSome(3, { unique: true }, [1,2,3,4,5]) // => [3,5,1]

// sequential pick
pickSome(3, { sequential: true }, [1,2,3,4,5]) // => [3,3,4]

// sequential & unique pick
pickSome(3, { unique: true, sequential: true }, [1,2,3,4,5]) // => [2,3,5]

// additional helpers
const { pickSomeUnique, pickSomeSequential } = require('pick-some');
pickSomeUnique(3, [1,2,3,4,5]) // => [3,5,1]
pickSomeSequential(3, [1,2,3,4,5]) // => [3,3,4]

license

MIT