randex 0.35.0 → 0.37.0

package/README.md

@@ -35,6 +35,7 @@ Many
 
 Generic Type:
 - [array](#array)
+- [RandexSpreader](#randexspreader)
 
 Deeps:
 
@@ -475,6 +476,35 @@ Randex.array(["1", "2", "3", "4"], 2);
 // ["1", "3"]
 ```
 
+## RandexSpreader
+
+Generates random values from an array without replacement until every item has
+been returned. The internal pool is then refilled automatically, so the
+spreader can be reused for as many values as needed.
+
+```ts
+import { RandexSpreader } from "randex";
+
+const spreader = new RandexSpreader(["red", "green", "blue"]);
+
+// Each item is returned once before the pool is refilled.
+spreader.spread(3);
+// ["green", "red", "blue"]
+
+// The next call continues from the current pool.
+spreader.spread(2);
+// ["red", "green"]
+```
+
+`RandexSpreader` supports any item type. An empty array or a non-positive count
+returns an empty array.
+
+```ts
+const numbers = new RandexSpreader<number>([1, 2, 3]);
+numbers.spread(5);
+// [2, 1, 3, 1, 2]
+```
+
 
 ## Customization
 

package/lib/test/{picker.test.js → spreader.test.js}

@@ -1,29 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var set_1 = require("../basic/set");
-var picker_1 = require("../utils/picker");
-describe("RandexPicker", function () {
-    it("picks from temp items without replacement", function () {
-        var picker = new picker_1.RandexPicker(["a", "b", "c"]);
+var spreader_1 = require("../utils/spreader");
+describe("RandexSpreader", function () {
+    it("spreads from temp items without replacement", function () {
+        var picker = new spreader_1.RandexSpreader(["a", "b", "c"]);
         var randomSpy = jest.spyOn(set_1.RandexSetUtil, "randomSingleNumber");
         randomSpy.mockReturnValueOnce(1).mockReturnValueOnce(0).mockReturnValueOnce(0);
-        expect(picker.pick(3)).toEqual(["b", "a", "c"]);
+        expect(picker.spread(3)).toEqual(["b", "a", "c"]);
         expect(picker._tempItems).toEqual([]);
         randomSpy.mockRestore();
     });
     it("keeps refilling until it returns the requested count", function () {
-        var picker = new picker_1.RandexPicker([1, 2]);
+        var picker = new spreader_1.RandexSpreader([1, 2]);
         var randomSpy = jest.spyOn(set_1.RandexSetUtil, "randomSingleNumber");
         randomSpy.mockReturnValueOnce(0).mockReturnValueOnce(0).mockReturnValueOnce(1).mockReturnValueOnce(0).mockReturnValueOnce(0);
-        expect(picker.pick(5)).toEqual([1, 2, 2, 1, 1]);
+        expect(picker.spread(5)).toEqual([1, 2, 2, 1, 1]);
         expect(picker._tempItems).toEqual([2]);
         randomSpy.mockRestore();
     });
     it("refills temp items until the requested count is reached", function () {
-        var picker = new picker_1.RandexPicker(["x", "y"]);
+        var picker = new spreader_1.RandexSpreader(["x", "y"]);
         var randomSpy = jest.spyOn(set_1.RandexSetUtil, "randomSingleNumber");
         randomSpy.mockReturnValueOnce(1).mockReturnValueOnce(0).mockReturnValueOnce(0);
-        expect(picker.pick(3)).toEqual(["y", "x", "x"]);
+        expect(picker.spread(3)).toEqual(["y", "x", "x"]);
         expect(picker._tempItems).toEqual(["y"]);
         randomSpy.mockRestore();
     });

package/lib/utils/index.d.ts

@@ -1 +1 @@
-export * from "./picker";
+export * from "./spreader";

package/lib/utils/index.js

@@ -14,4 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./picker"), exports);
+__exportStar(require("./spreader"), exports);

package/lib/utils/spreader.d.ts

@@ -0,0 +1,7 @@
+export declare class RandexSpreader<TItem = any> {
+    readonly items: TItem[];
+    private readonly _items;
+    private _tempItems;
+    constructor(items?: TItem[]);
+    spread(count?: number): TItem[];
+}

package/lib/utils/{picker.js → spreader.js}

@@ -9,16 +9,16 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RandexPicker = void 0;
+exports.RandexSpreader = void 0;
 var set_1 = require("../basic/set");
-var RandexPicker = /** @class */ (function () {
-    function RandexPicker(items) {
+var RandexSpreader = /** @class */ (function () {
+    function RandexSpreader(items) {
         if (items === void 0) { items = []; }
         this.items = items;
         this._items = items;
         this._tempItems = __spreadArray([], items, true);
     }
-    RandexPicker.prototype.pick = function (count) {
+    RandexSpreader.prototype.spread = function (count) {
         if (count === void 0) { count = 1; }
         if (!this._items.length || count <= 0) {
             return [];
@@ -34,6 +34,6 @@ var RandexPicker = /** @class */ (function () {
         }
         return result;
     };
-    return RandexPicker;
+    return RandexSpreader;
 }());
-exports.RandexPicker = RandexPicker;
+exports.RandexSpreader = RandexSpreader;

package/package.json

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

package/lib/utils/picker.d.ts

@@ -1,7 +0,0 @@
-export declare class RandexPicker {
-    readonly items: any[];
-    private readonly _items;
-    private _tempItems;
-    constructor(items?: any[]);
-    pick(count?: number): any[];
-}