randex 1.1.0 → 1.2.0

package/README.md

@@ -35,6 +35,7 @@ Many
 
 Generic Type:
 - [array](#array)
+- [spread](#spread)
 - [RandexSpreader](#randexspreader)
 
 Deeps:
@@ -476,6 +477,25 @@ Randex.array(["1", "2", "3", "4"], 2);
 // ["1", "3"]
 ```
 
+## spread
+
+`Randex.spread(array, count)` returns a new array containing the requested
+number of randomly selected items. Items are selected without replacement
+until the source array is exhausted. If `count` is greater than the source
+array length, the selection pool is refilled automatically.
+
+```ts
+import Randex from "randex";
+
+Randex.spread(["red", "green", "blue"], 5);
+// ["green", "red", "blue", "red", "green"]
+```
+
+The method returns an empty array when the source array is empty or when
+`count` is zero or negative. Each call starts with a new selection pool. Use
+[`RandexSpreader`](#randexspreader) when the pool should continue between
+multiple calls.
+
 ## RandexSpreader
 
 Generates random values from an array without replacement until every item has

package/lib/custom/index.d.ts

@@ -49,4 +49,5 @@ export declare class Randex {
             (from: number, to: number, options?: import("../interfaces").RandomNumberOptions | undefined): number[];
         };
     };
+    static spread<TItem>(array: TItem[], count: number): TItem[];
 }

package/lib/custom/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Randex = void 0;
+var utils_1 = require("../utils");
 var bool_1 = require("./bool");
 var email_1 = require("./email");
 var filenameX_1 = require("./filenameX");
@@ -47,6 +48,10 @@ var Randex = /** @class */ (function () {
     Randex.many = function (count) {
         return { word: (0, word_1.randexManyWord)(count), phrase: (0, phrase_1.randexManyPhrase)(count), sentence: (0, sentence_1.randexManySentence)(count), number: (0, number_1.randexManyNumber)(count) };
     };
+    Randex.spread = function (array, count) {
+        var picker = new utils_1.RandexSpreader(array);
+        return picker.spread(count);
+    };
     Randex.random = random_1.randexRandom;
     Randex.bool = bool_1.randexBool;
     Randex.email = email_1.randexEmail;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "randex",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",