my-idlers/node_modules/collect.js/docs/api/random.md

29 lines
723 B
Markdown
Raw Normal View History

# `random()`
The random method returns a random item from the collection:
```js
const collection = collect([1, 2, 3, 4, 5]);
collection.random();
// 4 (retrieved randomly)
```
You may optionally pass an integer to random to specify how many items you would like to randomly retrieve. A collection of items is always returned when explicitly passing the number of items you wish to receive:
```js
const threeRandom = collection.random(3);
// Collection { items: [ 5, 3, 4 ] } (retrieved randomly)
const oneRandom = collection.random(1);
// Collection { items: [ 3 ] } (retrieved randomly)
oneRandom.all();
// [3]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/random.js)