diff --git a/README.md b/README.md index b3ae419a1..a74229777 100644 --- a/README.md +++ b/README.md @@ -798,9 +798,9 @@ const sample = arr => arr[Math.floor(Math.random() * arr.length)]; ### 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]) => { @@ -811,7 +811,9 @@ 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] ``` [⬆ back to top](#table-of-contents) diff --git a/docs/index.html b/docs/index.html index d1d0d6820..3038db820 100644 --- a/docs/index.html +++ b/docs/index.html @@ -589,8 +589,8 @@ This method also works with strings.

// sample([3, 7, 9, 11]) -> 9

shuffle

-

Randomizes the order of the values of an array, in place.

-

Uses the Fisher-Yates algoritm to reorder the elements of the array, based on the Lodash implimentation

+

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 implementation, but as a pure function.

const shuffle = ([...arr]) => {
   let m = arr.length;
   while (m) {
@@ -599,7 +599,9 @@ This method also works with strings.

   }
   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]

similarity

Returns an array of elements that appear in both arrays.