Merge pull request #363 from billmei/billmei-shuffle-pure-function

Fix documentation for shuffle
This commit is contained in:
Angelos Chalaris
2017-12-27 10:20:44 +02:00
committed by GitHub

View File

@ -1,8 +1,8 @@
### shuffle
Randomizes the order of the values of an array, in place.
Randomizes the order of the values of an array, returning a new array.
Uses the Fisher-Yates algoritm to reorder the elements of the array, based on the [Lodash implimentation](https://github.com/lodash/lodash/blob/b2ea6b1cd251796dcb5f9700c4911a7b6223920b/shuffle.js)
Uses the Fisher-Yates algoritm to reorder the elements of the array, based on the [Lodash implementation](https://github.com/lodash/lodash/blob/b2ea6b1cd251796dcb5f9700c4911a7b6223920b/shuffle.js), but as a pure function.
```js
const shuffle = ([...arr]) => {
@ -13,5 +13,7 @@ const shuffle = ([...arr]) => {
}
return arr;
};
// shuffle([1,2,3]) -> [2,3,1]
// const foo = [1,2,3]
// shuffle(foo) -> [2,3,1]
// console.log(foo) -> [1,2,3]
```