util-helpers 5.7.8 → 5.8.0

package/esm/ConcurrencyController.js

@@ -0,0 +1,54 @@
+var ConcurrencyController = (function () {
+    function ConcurrencyController(maxConcurrency) {
+        if (maxConcurrency === void 0) { maxConcurrency = 2; }
+        this.maxConcurrency = Math.max(maxConcurrency, 1);
+        this.runningCount = 0;
+        this.queue = [];
+        this.isPaused = false;
+    }
+    ConcurrencyController.prototype.add = function (task) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            _this.queue.push({ task: task, resolve: resolve, reject: reject });
+            _this._run();
+        });
+    };
+    ConcurrencyController.prototype._run = function () {
+        var _this = this;
+        if (this.isPaused)
+            return;
+        while (this.runningCount < this.maxConcurrency && this.queue.length > 0) {
+            var _a = this.queue.shift(), task = _a.task, resolve = _a.resolve, reject = _a.reject;
+            this.runningCount++;
+            task()
+                .then(resolve)
+                .catch(reject)
+                .finally(function () {
+                _this.runningCount--;
+                _this._run();
+            });
+        }
+    };
+    ConcurrencyController.prototype.getStatus = function () {
+        return {
+            running: this.runningCount,
+            waiting: this.queue.length,
+            maxConcurrency: this.maxConcurrency,
+            paused: this.isPaused
+        };
+    };
+    ConcurrencyController.prototype.setMaxConcurrency = function (maxConcurrency) {
+        this.maxConcurrency = Math.max(maxConcurrency, 1);
+        this._run();
+    };
+    ConcurrencyController.prototype.pause = function () {
+        this.isPaused = true;
+    };
+    ConcurrencyController.prototype.resume = function () {
+        this.isPaused = false;
+        this._run();
+    };
+    return ConcurrencyController;
+}());
+
+export { ConcurrencyController as default };

package/esm/VERSION.js

@@ -1,3 +1,3 @@
-var VERSION = "5.7.8";
+var VERSION = "5.8.0";
 
 export { VERSION as default };

package/esm/index.js

@@ -68,3 +68,4 @@ export { default as findTreeSelect } from './findTreeSelect.js';
 export { setDisableWarning } from './utils/config.js';
 export { default as VERSION } from './VERSION.js';
 export { default as AsyncMemo } from './AsyncMemo.js';
+export { default as ConcurrencyController } from './ConcurrencyController.js';

package/lib/ConcurrencyController.js

@@ -0,0 +1,56 @@
+'use strict';
+
+var ConcurrencyController = (function () {
+    function ConcurrencyController(maxConcurrency) {
+        if (maxConcurrency === void 0) { maxConcurrency = 2; }
+        this.maxConcurrency = Math.max(maxConcurrency, 1);
+        this.runningCount = 0;
+        this.queue = [];
+        this.isPaused = false;
+    }
+    ConcurrencyController.prototype.add = function (task) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            _this.queue.push({ task: task, resolve: resolve, reject: reject });
+            _this._run();
+        });
+    };
+    ConcurrencyController.prototype._run = function () {
+        var _this = this;
+        if (this.isPaused)
+            return;
+        while (this.runningCount < this.maxConcurrency && this.queue.length > 0) {
+            var _a = this.queue.shift(), task = _a.task, resolve = _a.resolve, reject = _a.reject;
+            this.runningCount++;
+            task()
+                .then(resolve)
+                .catch(reject)
+                .finally(function () {
+                _this.runningCount--;
+                _this._run();
+            });
+        }
+    };
+    ConcurrencyController.prototype.getStatus = function () {
+        return {
+            running: this.runningCount,
+            waiting: this.queue.length,
+            maxConcurrency: this.maxConcurrency,
+            paused: this.isPaused
+        };
+    };
+    ConcurrencyController.prototype.setMaxConcurrency = function (maxConcurrency) {
+        this.maxConcurrency = Math.max(maxConcurrency, 1);
+        this._run();
+    };
+    ConcurrencyController.prototype.pause = function () {
+        this.isPaused = true;
+    };
+    ConcurrencyController.prototype.resume = function () {
+        this.isPaused = false;
+        this._run();
+    };
+    return ConcurrencyController;
+}());
+
+module.exports = ConcurrencyController;

package/lib/VERSION.js

@@ -1,5 +1,5 @@
 'use strict';
 
-var VERSION = "5.7.8";
+var VERSION = "5.8.0";
 
 module.exports = VERSION;

package/lib/index.js

@@ -70,6 +70,7 @@ var findTreeSelect = require('./findTreeSelect.js');
 var config = require('./utils/config.js');
 var VERSION = require('./VERSION.js');
 var AsyncMemo = require('./AsyncMemo.js');
+var ConcurrencyController = require('./ConcurrencyController.js');
 
 
 
@@ -143,3 +144,4 @@ exports.findTreeSelect = findTreeSelect;
 exports.setDisableWarning = config.setDisableWarning;
 exports.VERSION = VERSION;
 exports.AsyncMemo = AsyncMemo;
+exports.ConcurrencyController = ConcurrencyController;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "5.7.8",
+  "version": "5.8.0",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",

package/types/ConcurrencyController.d.ts

@@ -3,8 +3,25 @@ type AsyncFunc<T = any> = () => Promise<T>;
  * 并发控制器
  *
  * @class
- * @param {number} [maxConcurrency=2] 最大并发数量。
+ * @param {number} [maxConcurrency=2] 最大并发数量。默认 `2`。
  * @example
+ * // 最多同时运行 3 个异步任务
+ * const controller = new ConcurrencyController(3);
+ *
+ * const urls = ['/api/1', '/api/2', '/api/3', '/api/4', '/api/5', '/api/6'];
+ * const results = await Promise.all(urls.map(url => controller.add(() => fetch(url))));
+ *
+ * // 获取状态
+ * controller.getStatus();
+ *
+ * // 暂停队列
+ * controller.pause();
+ *
+ * // 恢复队列
+ * controller.resume();
+ *
+ * // 设置最大并发数量，并立即运行队列中的任务。
+ * controller.setMaxConcurrency(4);
  *
  */
 declare class ConcurrencyController {
@@ -13,15 +30,41 @@ declare class ConcurrencyController {
     private queue;
     private isPaused;
     constructor(maxConcurrency?: number);
+    /**
+     * 加入队列
+     *
+     * @param {Function} task 异步任务函数。
+     * @returns 任务的 Promise 对象。
+     */
     add<T>(task: AsyncFunc<T>): Promise<T>;
-    private run;
+    /**
+     * 运行队列中的任务
+     *
+     * @private
+     */
+    private _run;
+    /**
+     * 获取状态
+     */
     getStatus(): {
         running: number;
         waiting: number;
         maxConcurrency: number;
+        paused: boolean;
     };
+    /**
+     * 设置最大并发数量，并立即运行队列中的任务。
+     *
+     * @param {number} maxConcurrency 最大并发数量。不能小于 `1`。
+     */
     setMaxConcurrency(maxConcurrency: number): void;
+    /**
+     * 暂停队列
+     */
     pause(): void;
+    /**
+     * 恢复队列
+     */
     resume(): void;
 }
 export default ConcurrencyController;

package/types/index.d.ts

@@ -141,3 +141,4 @@ export { setDisableWarning } from './utils/config';
 import VERSION from './VERSION';
 export { VERSION };
 export { default as AsyncMemo } from './AsyncMemo';
+export { default as ConcurrencyController } from './ConcurrencyController';