smath 1.9.2 → 1.10.0

package/dist/index.js

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SMath = void 0;
 /**
  * @packageDocumentation
- * ![NPM Downloads](https://img.shields.io/npm/d18m/smath) Small math function library
+ * Small math function library
+ *
+ * ![NPM Downloads](https://img.shields.io/npm/d18m/smath)
  */
 /**
  * Contains a small math function library including
@@ -404,6 +406,7 @@ var SMath;
      * ```js
      * const sequence = SMath.rseq(-2, 2); // [ 2, 0, 1, -2, -1 ]
      * ```
+     * @deprecated Use `SMath.shuffle()` instead
      */
     function rseq(min, max) {
         min |= 0;
@@ -416,6 +419,23 @@ var SMath;
         return rawData.sort(function (a, b) { return a.index - b.index; }).map(function (a) { return a.value; });
     }
     SMath.rseq = rseq;
+    /**
+     * Randomize an array of arbitrary elements.
+     * @param stack An array of arbitrary elements
+     * @returns The `stack` array in a random order
+     * @example
+     * ```js
+     * ```
+     */
+    function shuffle(stack) {
+        var rawData = [];
+        for (var _i = 0, stack_1 = stack; _i < stack_1.length; _i++) {
+            var item = stack_1[_i];
+            rawData.push({ index: Math.random(), value: item });
+        }
+        return rawData.sort(function (a, b) { return a.index - b.index; }).map(function (a) { return a.value; });
+    }
+    SMath.shuffle = shuffle;
     /**
      * Take the limit of a function. A return value of `NaN` indicates
      * that no limit exists either due to a discontinuity or imaginary value.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smath",
-  "version": "1.9.2",
+  "version": "1.10.0",
   "description": "Small math function library",
   "homepage": "https://npm.nicfv.com/",
   "bin": "dist/bin.js",

package/types/index.d.ts

@@ -1,6 +1,8 @@
 /**
  * @packageDocumentation
- * ![NPM Downloads](https://img.shields.io/npm/d18m/smath) Small math function library
+ * Small math function library
+ *
+ * ![NPM Downloads](https://img.shields.io/npm/d18m/smath)
  */
 /**
  * Contains a small math function library including
@@ -270,8 +272,18 @@ export declare namespace SMath {
      * ```js
      * const sequence = SMath.rseq(-2, 2); // [ 2, 0, 1, -2, -1 ]
      * ```
+     * @deprecated Use `SMath.shuffle()` instead
      */
     function rseq(min: number, max: number): Array<number>;
+    /**
+     * Randomize an array of arbitrary elements.
+     * @param stack An array of arbitrary elements
+     * @returns The `stack` array in a random order
+     * @example
+     * ```js
+     * ```
+     */
+    function shuffle<T>(stack: Array<T>): Array<T>;
     /**
      * Take the limit of a function. A return value of `NaN` indicates
      * that no limit exists either due to a discontinuity or imaginary value.