Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

pick-random

sindresorhus14.6kMIT4.0.0TypeScript support: included

Pick random items from a list

pick, choose, random, list, raffle, item, element, decision, winner, picking, picker, choosing

readme

pick-random

Pick random items from a list

Useful for making decisions, picking a winner, or anything else randomness can help you with.

Install

$ npm install pick-random

Usage

import pickRandom from 'pick-random';

pickRandom(['Sindre', 'Stephen', 'Unicorn', 'Pascal', 'Addy', 'Pony'], {count: 2});
//=> ['Unicorn', 'Pony']

pickRandom(input, options?)

Returns an Array.

input

Type: Array

The list to pick from.

options

Type: object

count

Type: number\ Default: 1

The number of picks.

Must be smaller or the same length as input.