deploy: c589858

github-actions[bot] · github-actions[bot] · commit 77b1b5486cd0 · 2025-03-15T18:55:05.000Z
diff --git a/dist/immutable.d.ts b/dist/immutable.d.ts
@@ -758,6 +758,14 @@ declare namespace Immutable {
       zipper: (...values: Array<unknown>) => Z,
       ...collections: Array<Collection<unknown, unknown>>
     ): List<Z>;
+
+    /**
+     * Returns a new List with its values shuffled thanks to the
+     * [Fisher–Yates](https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle)
+     * algorithm.
+     * It uses Math.random, but you can provide your own random number generator.
+     */
+    shuffle(random?: () => number): this;
   }
 
   /**
diff --git a/dist/immutable.es.js b/dist/immutable.es.js
@@ -3469,6 +3469,25 @@ var List = /*@__PURE__*/(function (IndexedCollection) {
     return setListBounds(this, 1);
   };
 
+  List.prototype.shuffle = function shuffle (random) {
+    if ( random === void 0 ) random = Math.random;
+
+    return this.withMutations(function (mutable) {
+      // implementation of the Fisher-Yates shuffle: https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle
+      var current = mutable.size;
+      var destination;
+      var tmp;
+
+      while (current) {
+        destination = Math.floor(random() * current--);
+
+        tmp = mutable.get(destination);
+        mutable.set(destination, mutable.get(current));
+        mutable.set(current, tmp);
+      }
+    });
+  };
+
   // @pragma Composition
 
   List.prototype.concat = function concat (/*...collections*/) {
diff --git a/dist/immutable.js b/dist/immutable.js
@@ -3475,6 +3475,25 @@
         return setListBounds(this, 1);
       };
 
+      List.prototype.shuffle = function shuffle (random) {
+        if ( random === void 0 ) random = Math.random;
+
+        return this.withMutations(function (mutable) {
+          // implementation of the Fisher-Yates shuffle: https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle
+          var current = mutable.size;
+          var destination;
+          var tmp;
+
+          while (current) {
+            destination = Math.floor(random() * current--);
+
+            tmp = mutable.get(destination);
+            mutable.set(destination, mutable.get(current));
+            mutable.set(current, tmp);
+          }
+        });
+      };
+
       // @pragma Composition
 
       List.prototype.concat = function concat (/*...collections*/) {
diff --git a/dist/immutable.min.js b/dist/immutable.min.js
