summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/helpers/pickset.md
blob: 3c3b393a3df413d6db93efc02fd1b960e90e0f64 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# pickset

```js
// usage
chance.pickset(array, quantity)
```

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

```js
chance.pickset(['alpha', 'bravo', 'charlie', 'delta', 'echo'], 3);
=> ['echo', 'alpha', 'bravo']
```

Optionally omit the quantity to retrieve a set with length 1

```js
chance.pickset(['alpha', 'bravo', 'charlie', 'delta', 'echo']);
=> ['delta']
```