await-num-q 1.0.1 → 1.1.2

package/README.md

@@ -0,0 +1,70 @@
+# await-num-q 限数阀
+
+## 介绍
+这是一个用于解决异步任务数量太大需要限制异步任务数量的 库，比如浏览器端 一次性发送很多的请求会导致请求挂起，例如在有大量图片加载时 网络不太好会导致后续其他的接口请求挂起得不到反馈，这时需要一个工具来解决同时请求图片的数量不得大于某个值，这样后续的接口请求才能正常的发送。于是此库便诞生了
+## 下载
+```sh
+npm i await-num-q
+# or
+pnpm i await-num-q
+# or
+yarn i await-num-q
+```
+
+## 使用
+
+> 导入
+```js
+import { asyncQueue } from 'await-num-q'
+```
+> 初始化队列
+```js
+let q = new asyncQueue(3)// 3 表示能够同时在当前队列执行的任务数量
+```
+> 执行
+```js
+async function test(){
+    async function _get(){}
+    let data = await q.wait(_get) // 这样就能拿到请求的数据 且不会超过指定数量
+}
+```
+## api列表
+
+```ts
+export type RunFunBoj = {
+    status: "wait" | "ing" | "end";
+    target: Function;
+    callback?: Function;
+    err?: Function;
+};
+export declare class asyncQueue {
+    #private;
+    constructor(max?: number);
+    /**
+     * 添加任务
+     * @param f 目标函数
+     * @param callback 成功回调函数
+     * @param err 错误回调函数
+     * @returns 添加成功与否
+     */
+    push(f: Function, callback?: Function, err?: Function): boolean;
+    /**
+     * 清除运行完成的任务
+     */
+    clear(): void;
+    /**
+     * 添加并运行任务 若是没有传入函数 运行 之前传入的任务
+     * @param f 目标函数
+     * @param callback 成功回调函数
+     * @param err 错误回调函数
+     * @returns 添加成功与否
+     */
+    run(f?: Function, callback?: Function, err?: Function): Promise<void>;
+    /**
+     * 异步运行并得到返回值
+     * @param fun 目标函数
+     * @returns
+     */
+    wait(fun: (...arg: any) => any): Promise<any>;
+}
+```

package/dist/index.d.ts

@@ -34,3 +34,13 @@ export declare class asyncQueue {
      */
     wait(fun: (...arg: any) => any): Promise<any>;
 }
+/**
+ * 在某个异步请求 参数相同 返回的值相同
+ * 并且在同一时间段 会发送多个亲求的场景
+ * 压缩正在进行的异步请求 为一个
+ * 避免同时条用多个请求导致后续请求 挂起
+ * @param asyncFun 异步函数
+ * @param param 函数传参 必须传入支持序列化的
+ * @returns
+ */
+export declare function MergeAsync<T extends (...args: any) => Promise<any>>(asyncFun: T, ...param: Parameters<T>): Promise<ReturnType<T>>;

package/dist/index.js

@@ -21,7 +21,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _asyncQueue_Queue, _asyncQueue_runNum, _asyncQueue_maxNum;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asyncQueue = void 0;
+exports.MergeAsync = exports.asyncQueue = void 0;
 class asyncQueue {
     constructor(max) {
         _asyncQueue_Queue.set(this, []);
@@ -46,7 +46,7 @@ class asyncQueue {
             status: "wait",
             target: f,
             callback,
-            err
+            err,
         };
         __classPrivateFieldGet(this, _asyncQueue_Queue, "f").push(funObj);
         this.clear();
@@ -56,7 +56,7 @@ class asyncQueue {
      * 清除运行完成的任务
      */
     clear() {
-        __classPrivateFieldSet(this, _asyncQueue_Queue, __classPrivateFieldGet(this, _asyncQueue_Queue, "f").filter(item => item.status !== 'end'), "f");
+        __classPrivateFieldSet(this, _asyncQueue_Queue, __classPrivateFieldGet(this, _asyncQueue_Queue, "f").filter((item) => item.status !== "end"), "f");
     }
     /**
      * 添加并运行任务 若是没有传入函数 运行 之前传入的任务
@@ -76,14 +76,15 @@ class asyncQueue {
             }
             let fun = null;
             for (let f of __classPrivateFieldGet(this, _asyncQueue_Queue, "f")) {
-                if (f.status == 'wait') {
+                if (f.status == "wait") {
                     fun = f;
+                    break;
                 }
             }
             if (fun) {
                 let data = null;
                 try {
-                    fun.status = 'ing';
+                    fun.status = "ing";
                     __classPrivateFieldSet(this, _asyncQueue_runNum, (_a = __classPrivateFieldGet(this, _asyncQueue_runNum, "f"), _a++, _a), "f");
                     data = yield fun.target();
                     if (fun.callback instanceof Function) {
@@ -97,7 +98,7 @@ class asyncQueue {
                 }
                 finally {
                     __classPrivateFieldSet(this, _asyncQueue_runNum, (_b = __classPrivateFieldGet(this, _asyncQueue_runNum, "f"), _b--, _b), "f");
-                    fun.status = 'end';
+                    fun.status = "end";
                     this.run();
                 }
             }
@@ -118,4 +119,26 @@ class asyncQueue {
 }
 exports.asyncQueue = asyncQueue;
 _asyncQueue_Queue = new WeakMap(), _asyncQueue_runNum = new WeakMap(), _asyncQueue_maxNum = new WeakMap();
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBTUEsTUFBYSxVQUFVO0lBSW5CLFlBQVksR0FBWTtRQUh4Qiw0QkFBc0IsRUFBRSxFQUFBO1FBQ3hCLDZCQUFVLENBQUMsRUFBQTtRQUNYLDZCQUFVLENBQUMsRUFBQTtRQUVQLElBQUksR0FBRyxFQUFFLENBQUM7WUFDTix1QkFBQSxJQUFJLHNCQUFXLEdBQUcsTUFBQSxDQUFBO1FBQ3RCLENBQUM7SUFDTCxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsSUFBSSxDQUFDLENBQVcsRUFBRSxRQUFtQixFQUFFLEdBQWM7UUFDakQsSUFBSSxDQUFDLENBQUMsV0FBVyxDQUFDLElBQUksS0FBSyxlQUFlLEVBQUUsQ0FBQztZQUN6QyxPQUFPLEtBQUssQ0FBQTtRQUNoQixDQUFDO1FBQ0QsSUFBSSxNQUFNLEdBQWM7WUFDcEIsTUFBTSxFQUFFLE1BQU07WUFDZCxNQUFNLEVBQUUsQ0FBQztZQUNULFFBQVE7WUFDUixHQUFHO1NBQ04sQ0FBQTtRQUNELHVCQUFBLElBQUkseUJBQU8sQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUE7UUFDeEIsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQ1osT0FBTyxJQUFJLENBQUE7SUFDZixDQUFDO0lBRUQ7O09BRUc7SUFDSCxLQUFLO1FBQ0QsdUJBQUEsSUFBSSxxQkFBVSx1QkFBQSxJQUFJLHlCQUFPLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLE1BQU0sS0FBSyxLQUFLLENBQUMsTUFBQSxDQUFBO0lBQ25FLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDRyxHQUFHLENBQUMsQ0FBWSxFQUFFLFFBQW1CLEVBQUUsR0FBYzs7O1lBQ3ZELElBQUksQ0FBQyxFQUFFLENBQUM7Z0JBQ0osSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLEVBQUUsUUFBUSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1lBQy9CLENBQUM7WUFDRCxJQUFJLHVCQUFBLElBQUksMEJBQVEsSUFBSSx1QkFBQSxJQUFJLDBCQUFRLEVBQUUsQ0FBQztnQkFDL0IsT0FBTTtZQUNWLENBQUM7WUFDRCxJQUFJLEdBQUcsR0FBcUIsSUFBSSxDQUFBO1lBQ2hDLEtBQUssSUFBSSxDQUFDLElBQUksdUJBQUEsSUFBSSx5QkFBTyxFQUFFLENBQUM7Z0JBQ3hCLElBQUksQ0FBQyxDQUFDLE1BQU0sSUFBSSxNQUFNLEVBQUUsQ0FBQztvQkFDckIsR0FBRyxHQUFHLENBQUMsQ0FBQTtnQkFDWCxDQUFDO1lBQ0wsQ0FBQztZQUNELElBQUksR0FBRyxFQUFFLENBQUM7Z0JBQ04sSUFBSSxJQUFJLEdBQVEsSUFBSSxDQUFBO2dCQUNwQixJQUFJLENBQUM7b0JBQ0QsR0FBRyxDQUFDLE1BQU0sR0FBRyxLQUFLLENBQUE7b0JBQ2xCLGlEQUFBLENBQUEsMERBQVksRUFBWixJQUFlLElBQUEsQ0FBQSxNQUFBLENBQUE7b0JBQ2YsSUFBSSxHQUFHLE1BQU0sR0FBRyxDQUFDLE1BQU0sRUFBRSxDQUFBO29CQUN6QixJQUFJLEdBQUcsQ0FBQyxRQUFRLFlBQVksUUFBUSxFQUFFLENBQUM7d0JBQ25DLEdBQUcsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUE7b0JBQ3RCLENBQUM7Z0JBQ0wsQ0FBQztnQkFBQyxXQUFNLENBQUM7b0JBQ0wsSUFBSSxHQUFHLENBQUMsR0FBRyxZQUFZLFFBQVEsRUFBRSxDQUFDO3dCQUM5QixHQUFHLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFBO29CQUNqQixDQUFDO2dCQUNMLENBQUM7d0JBQVMsQ0FBQztvQkFDUCxpREFBQSxDQUFBLDBEQUFZLEVBQVosSUFBZSxJQUFBLENBQUEsTUFBQSxDQUFBO29CQUNmLEdBQUcsQ0FBQyxNQUFNLEdBQUcsS0FBSyxDQUFBO29CQUNsQixJQUFJLENBQUMsR0FBRyxFQUFFLENBQUE7Z0JBQ2QsQ0FBQztZQUNMLENBQUM7UUFDTCxDQUFDO0tBQUE7SUFFRDs7OztPQUlHO0lBQ0csSUFBSSxDQUFDLEdBQXlCOztZQUNoQyxPQUFPLE1BQU0sSUFBSSxPQUFPLENBQXlCLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxFQUFFO2dCQUMxRCxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUE7WUFDM0IsQ0FBQyxDQUFDLENBQUE7UUFDTixDQUFDO0tBQUE7Q0FDSjtBQTFGRCxnQ0EwRkMifQ==
+const mergePromise = new WeakMap();
+/**
+ * 在某个异步请求 参数相同 返回的值相同
+ * 并且在同一时间段 会发送多个亲求的场景
+ * 压缩正在进行的异步请求 为一个
+ * 避免同时条用多个请求导致后续请求 挂起
+ * @param asyncFun 异步函数
+ * @param param 函数传参 必须传入支持序列化的
+ * @returns
+ */
+function MergeAsync(asyncFun, ...param) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let key = JSON.stringify(param);
+        if (mergePromise.has(key)) {
+            return mergePromise.get(key);
+        }
+        let r = (yield asyncFun(...param));
+        mergePromise.delete(key);
+        return r;
+    });
+}
+exports.MergeAsync = MergeAsync;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBTUEsTUFBYSxVQUFVO0lBSXJCLFlBQVksR0FBWTtRQUh4Qiw0QkFBc0IsRUFBRSxFQUFDO1FBQ3pCLDZCQUFVLENBQUMsRUFBQztRQUNaLDZCQUFVLENBQUMsRUFBQztRQUVWLElBQUksR0FBRyxFQUFFLENBQUM7WUFDUix1QkFBQSxJQUFJLHNCQUFXLEdBQUcsTUFBQSxDQUFDO1FBQ3JCLENBQUM7SUFDSCxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsSUFBSSxDQUFDLENBQVcsRUFBRSxRQUFtQixFQUFFLEdBQWM7UUFDbkQsSUFBSSxDQUFDLENBQUMsV0FBVyxDQUFDLElBQUksS0FBSyxlQUFlLEVBQUUsQ0FBQztZQUMzQyxPQUFPLEtBQUssQ0FBQztRQUNmLENBQUM7UUFDRCxJQUFJLE1BQU0sR0FBYztZQUN0QixNQUFNLEVBQUUsTUFBTTtZQUNkLE1BQU0sRUFBRSxDQUFDO1lBQ1QsUUFBUTtZQUNSLEdBQUc7U0FDSixDQUFDO1FBQ0YsdUJBQUEsSUFBSSx5QkFBTyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUN6QixJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDYixPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7T0FFRztJQUNILEtBQUs7UUFDSCx1QkFBQSxJQUFJLHFCQUFVLHVCQUFBLElBQUkseUJBQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxNQUFNLEtBQUssS0FBSyxDQUFDLE1BQUEsQ0FBQztJQUNwRSxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0csR0FBRyxDQUFDLENBQVksRUFBRSxRQUFtQixFQUFFLEdBQWM7OztZQUN6RCxJQUFJLENBQUMsRUFBRSxDQUFDO2dCQUNOLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxFQUFFLFFBQVEsRUFBRSxHQUFHLENBQUMsQ0FBQztZQUM5QixDQUFDO1lBQ0QsSUFBSSx1QkFBQSxJQUFJLDBCQUFRLElBQUksdUJBQUEsSUFBSSwwQkFBUSxFQUFFLENBQUM7Z0JBQ2pDLE9BQU87WUFDVCxDQUFDO1lBQ0QsSUFBSSxHQUFHLEdBQXFCLElBQUksQ0FBQztZQUNqQyxLQUFLLElBQUksQ0FBQyxJQUFJLHVCQUFBLElBQUkseUJBQU8sRUFBRSxDQUFDO2dCQUMxQixJQUFJLENBQUMsQ0FBQyxNQUFNLElBQUksTUFBTSxFQUFFLENBQUM7b0JBQ3ZCLEdBQUcsR0FBRyxDQUFDLENBQUM7b0JBQ1IsTUFBTTtnQkFDUixDQUFDO1lBQ0gsQ0FBQztZQUNELElBQUksR0FBRyxFQUFFLENBQUM7Z0JBQ1IsSUFBSSxJQUFJLEdBQVEsSUFBSSxDQUFDO2dCQUNyQixJQUFJLENBQUM7b0JBQ0gsR0FBRyxDQUFDLE1BQU0sR0FBRyxLQUFLLENBQUM7b0JBQ25CLGlEQUFBLENBQUEsMERBQVksRUFBWixJQUFjLElBQUEsQ0FBQSxNQUFBLENBQUM7b0JBQ2YsSUFBSSxHQUFHLE1BQU0sR0FBRyxDQUFDLE1BQU0sRUFBRSxDQUFDO29CQUMxQixJQUFJLEdBQUcsQ0FBQyxRQUFRLFlBQVksUUFBUSxFQUFFLENBQUM7d0JBQ3JDLEdBQUcsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUM7b0JBQ3JCLENBQUM7Z0JBQ0gsQ0FBQztnQkFBQyxXQUFNLENBQUM7b0JBQ1AsSUFBSSxHQUFHLENBQUMsR0FBRyxZQUFZLFFBQVEsRUFBRSxDQUFDO3dCQUNoQyxHQUFHLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO29CQUNoQixDQUFDO2dCQUNILENBQUM7d0JBQVMsQ0FBQztvQkFDVCxpREFBQSxDQUFBLDBEQUFZLEVBQVosSUFBYyxJQUFBLENBQUEsTUFBQSxDQUFDO29CQUNmLEdBQUcsQ0FBQyxNQUFNLEdBQUcsS0FBSyxDQUFDO29CQUNuQixJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7Z0JBQ2IsQ0FBQztZQUNILENBQUM7UUFDSCxDQUFDO0tBQUE7SUFFRDs7OztPQUlHO0lBQ0csSUFBSSxDQUFDLEdBQXlCOztZQUNsQyxPQUFPLE1BQU0sSUFBSSxPQUFPLENBQXlCLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxFQUFFO2dCQUM1RCxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUM7WUFDMUIsQ0FBQyxDQUFDLENBQUM7UUFDTCxDQUFDO0tBQUE7Q0FDRjtBQTNGRCxnQ0EyRkM7O0FBRUQsTUFBTSxZQUFZLEdBQUcsSUFBSSxPQUFPLEVBQUUsQ0FBQztBQUVuQzs7Ozs7Ozs7R0FRRztBQUNILFNBQXNCLFVBQVUsQ0FDOUIsUUFBVyxFQUNYLEdBQUcsS0FBb0I7O1FBRXZCLElBQUksR0FBRyxHQUFHLElBQUksQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFXLENBQUM7UUFDMUMsSUFBSSxZQUFZLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7WUFDMUIsT0FBTyxZQUFZLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBa0IsQ0FBQztRQUNoRCxDQUFDO1FBQ0QsSUFBSSxDQUFDLEdBQUcsQ0FBQyxNQUFNLFFBQVEsQ0FBQyxHQUFHLEtBQUssQ0FBQyxDQUFrQixDQUFDO1FBQ3BELFlBQVksQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDekIsT0FBTyxDQUFDLENBQUM7SUFDWCxDQUFDO0NBQUE7QUFYRCxnQ0FXQyJ9

package/package.json

@@ -1,13 +1,13 @@
-{
-  "name": "await-num-q",
-  "version": "1.0.1",
-  "description": "一个用于 处理 指定并行异步任务数量的 队列",
-  "keywords":["q","await","async","队列","异步","并行"],
-  "main": "dist/index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "types": "dist/index.d.ts",
-  "author": "xxl.nice@foxmail.com",
-  "license": "ISC"
-}
+{
+  "name": "await-num-q",
+  "version": "1.1.2",
+  "description": "一个用于 处理 指定并行异步任务数量的 队列",
+  "keywords":["q","await","async","队列","异步","并行"],
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "types": "dist/index.d.ts",
+  "author": "xxl.nice@foxmail.com",
+  "license": "ISC"
+}

package/tsconfig.json

@@ -12,7 +12,7 @@
 
     /* Language and Environment */
     "target": "ES2015",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
-    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "lib": ["DOM","Decorators"],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
     // "jsx": "preserve",                                /* Specify what JSX code is generated. */
     // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
     // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */