await-num-q 1.2.4-test → 1.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -5
- package/dist/index.d.ts +18 -5
- package/dist/index.js +8 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
1
|
# await-num-q 限数阀
|
|
2
|
-
|
|
2
|
+
## 关键字
|
|
3
|
+
- 异步
|
|
4
|
+
- 队列
|
|
5
|
+
- 限数阀
|
|
6
|
+
- 限制异步任务数量
|
|
7
|
+
- 压缩请求
|
|
8
|
+
- 合并请求
|
|
3
9
|
## 介绍
|
|
4
|
-
|
|
10
|
+
这是一个用于解决异步任务数量太大需要`限制异步任务数量的库`，比如浏览器端 一次性发送很多的请求会导致请求挂起，例如在有大量图片加载时 网络不太好会导致后续其他的接口请求挂起得不到反馈，这时需要一个工具来解决同时请求图片的数量不得大于某个值，这样后续的接口请求才能正常的发送。于是此库便诞生了
|
|
5
11
|
## 下载
|
|
6
12
|
```sh
|
|
7
13
|
npm i await-num-q
|
|
@@ -31,15 +37,33 @@ async function test(){
|
|
|
31
37
|
## api列表
|
|
32
38
|
|
|
33
39
|
```ts
|
|
40
|
+
/**
|
|
41
|
+
* 异步参数对象
|
|
42
|
+
* @property max 最大并发数
|
|
43
|
+
* @property retry 失败重试次数
|
|
44
|
+
* @property endCallback 队列结束回调函数
|
|
45
|
+
*/
|
|
46
|
+
export type AsyncParams = {
|
|
47
|
+
max?: number;
|
|
48
|
+
retry?: number;
|
|
49
|
+
endCallback?: () => void;
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* 异步任务对象
|
|
53
|
+
*/
|
|
34
54
|
export type RunFunBoj = {
|
|
35
|
-
status: "wait" | "ing" | "end";
|
|
55
|
+
status: "wait" | "ing" | "end" | "fail";
|
|
36
56
|
target: Function;
|
|
57
|
+
retry: number;
|
|
37
58
|
callback?: Function;
|
|
38
59
|
err?: Function;
|
|
39
60
|
};
|
|
61
|
+
/**
|
|
62
|
+
* 异步队列
|
|
63
|
+
*/
|
|
40
64
|
export declare class asyncQueue {
|
|
41
65
|
#private;
|
|
42
|
-
constructor(max
|
|
66
|
+
constructor({ max, retry, endCallback, }: AsyncParams);
|
|
43
67
|
/**
|
|
44
68
|
* 添加任务
|
|
45
69
|
* @param f 目标函数
|
|
@@ -51,7 +75,7 @@ export declare class asyncQueue {
|
|
|
51
75
|
/**
|
|
52
76
|
* 清除运行完成的任务
|
|
53
77
|
*/
|
|
54
|
-
clear(): void;
|
|
78
|
+
clear(fial?: boolean): void;
|
|
55
79
|
/**
|
|
56
80
|
* 添加并运行任务 若是没有传入函数 运行 之前传入的任务
|
|
57
81
|
* @param f 目标函数
|
|
@@ -60,6 +84,11 @@ export declare class asyncQueue {
|
|
|
60
84
|
* @returns 添加成功与否
|
|
61
85
|
*/
|
|
62
86
|
run(f?: Function, callback?: Function, err?: Function): Promise<void>;
|
|
87
|
+
/**
|
|
88
|
+
* 获取所有的 任务
|
|
89
|
+
* @returns
|
|
90
|
+
*/
|
|
91
|
+
getTasks(): RunFunBoj[];
|
|
63
92
|
/**
|
|
64
93
|
* 异步运行并得到返回值
|
|
65
94
|
* @param fun 目标函数
|
|
@@ -67,4 +96,15 @@ export declare class asyncQueue {
|
|
|
67
96
|
*/
|
|
68
97
|
wait(fun: (...arg: any) => any): Promise<any>;
|
|
69
98
|
}
|
|
99
|
+
/**
|
|
100
|
+
* 在某个异步请求 参数相同 返回的值相同
|
|
101
|
+
* 并且在同一时间段 会发送多个亲求的场景
|
|
102
|
+
* 压缩正在进行的异步请求 为一个
|
|
103
|
+
* 避免同时条用多个请求导致后续请求 挂起
|
|
104
|
+
* @param asyncFun 异步函数
|
|
105
|
+
* @param param 函数传参 必须传入支持序列化的
|
|
106
|
+
* @returns
|
|
107
|
+
*/
|
|
108
|
+
export declare function MergeAsync<T extends (...args: any) => Promise<any>>(asyncFun: T, ...param: Parameters<T>): Promise<ReturnType<T>>;
|
|
109
|
+
|
|
70
110
|
```
|
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 异步参数对象
|
|
3
|
+
* @property max 最大并发数
|
|
4
|
+
* @property retry 失败重试次数
|
|
5
|
+
* @property endCallback 队列结束回调函数
|
|
6
|
+
*/
|
|
7
|
+
export type AsyncParams = {
|
|
8
|
+
max?: number;
|
|
9
|
+
retry?: number;
|
|
10
|
+
endCallback?: () => void;
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* 异步任务对象
|
|
14
|
+
*/
|
|
1
15
|
export type RunFunBoj = {
|
|
2
16
|
status: "wait" | "ing" | "end" | "fail";
|
|
3
17
|
target: Function;
|
|
@@ -5,13 +19,12 @@ export type RunFunBoj = {
|
|
|
5
19
|
callback?: Function;
|
|
6
20
|
err?: Function;
|
|
7
21
|
};
|
|
22
|
+
/**
|
|
23
|
+
* 异步队列
|
|
24
|
+
*/
|
|
8
25
|
export declare class asyncQueue {
|
|
9
26
|
#private;
|
|
10
|
-
constructor({ max, retry, endCallback, }:
|
|
11
|
-
max?: number;
|
|
12
|
-
retry?: number;
|
|
13
|
-
endCallback?: () => void;
|
|
14
|
-
});
|
|
27
|
+
constructor({ max, retry, endCallback, }: AsyncParams);
|
|
15
28
|
/**
|
|
16
29
|
* 添加任务
|
|
17
30
|
* @param f 目标函数
|
package/dist/index.js
CHANGED
|
@@ -22,6 +22,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
|
|
|
22
22
|
var _asyncQueue_Queue, _asyncQueue_runNum, _asyncQueue_retry, _asyncQueue_maxNum, _asyncQueue_status, _asyncQueue_endCallback;
|
|
23
23
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
24
24
|
exports.MergeAsync = exports.asyncQueue = void 0;
|
|
25
|
+
/**
|
|
26
|
+
* 异步队列
|
|
27
|
+
*/
|
|
25
28
|
class asyncQueue {
|
|
26
29
|
constructor({ max, retry, endCallback, }) {
|
|
27
30
|
_asyncQueue_Queue.set(this, []);
|
|
@@ -46,7 +49,7 @@ class asyncQueue {
|
|
|
46
49
|
* @returns 添加成功与否
|
|
47
50
|
*/
|
|
48
51
|
push(f, callback, err) {
|
|
49
|
-
if (f.constructor.name !== "
|
|
52
|
+
if (f.constructor.name !== "Function") {
|
|
50
53
|
return false;
|
|
51
54
|
}
|
|
52
55
|
let funObj = {
|
|
@@ -123,6 +126,9 @@ class asyncQueue {
|
|
|
123
126
|
__classPrivateFieldSet(this, _asyncQueue_status, "end", "f");
|
|
124
127
|
__classPrivateFieldGet(this, _asyncQueue_endCallback, "f").call(this);
|
|
125
128
|
}
|
|
129
|
+
else if (__classPrivateFieldGet(this, _asyncQueue_Queue, "f").length === 0) {
|
|
130
|
+
__classPrivateFieldGet(this, _asyncQueue_endCallback, "f").call(this);
|
|
131
|
+
}
|
|
126
132
|
}
|
|
127
133
|
});
|
|
128
134
|
}
|
|
@@ -170,4 +176,4 @@ function MergeAsync(asyncFun, ...param) {
|
|
|
170
176
|
});
|
|
171
177
|
}
|
|
172
178
|
exports.MergeAsync = MergeAsync;
|
|
173
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
179
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBdUJBOztHQUVHO0FBQ0gsTUFBYSxVQUFVO0lBT3JCLFlBQVksRUFDVixHQUFHLEVBQ0gsS0FBSyxFQUNMLFdBQVcsR0FDQztRQVZkLDRCQUFzQixFQUFFLEVBQUM7UUFDekIsNkJBQVUsQ0FBQyxFQUFDO1FBQ1osNEJBQVMsQ0FBQyxFQUFDO1FBQ1gsNkJBQVUsQ0FBQyxFQUFDO1FBQ1osNkJBQXlCLEtBQUssRUFBQztRQUMvQiwwQ0FBeUI7UUFNdkIsSUFBSSxHQUFHLEVBQUUsQ0FBQztZQUNSLHVCQUFBLElBQUksc0JBQVcsR0FBRyxNQUFBLENBQUM7UUFDckIsQ0FBQztRQUNELElBQUksS0FBSyxFQUFFLENBQUM7WUFDVix1QkFBQSxJQUFJLHFCQUFVLEtBQUssTUFBQSxDQUFDO1FBQ3RCLENBQUM7UUFFRCx1QkFBQSxJQUFJLDJCQUFnQixXQUFXLElBQUksY0FBYSxDQUFDLE1BQUEsQ0FBQztJQUNwRCxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsSUFBSSxDQUFDLENBQVcsRUFBRSxRQUFtQixFQUFFLEdBQWM7UUFDbkQsSUFBSSxDQUFDLENBQUMsV0FBVyxDQUFDLElBQUksS0FBSyxVQUFVLEVBQUUsQ0FBQztZQUN0QyxPQUFPLEtBQUssQ0FBQztRQUNmLENBQUM7UUFDRCxJQUFJLE1BQU0sR0FBYztZQUN0QixNQUFNLEVBQUUsTUFBTTtZQUNkLE1BQU0sRUFBRSxDQUFDO1lBQ1QsS0FBSyxFQUFFLHVCQUFBLElBQUkseUJBQU87WUFDbEIsUUFBUTtZQUNSLEdBQUc7U0FDSixDQUFDO1FBQ0YsdUJBQUEsSUFBSSx5QkFBTyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUN6QixJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDYixPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7T0FFRztJQUNILEtBQUssQ0FBQyxJQUFJLEdBQUcsS0FBSztRQUNoQix1QkFBQSxJQUFJLHFCQUFVLHVCQUFBLElBQUkseUJBQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUN4QyxJQUFJLENBQUMsTUFBTSxLQUFLLEtBQUssSUFBSSxJQUFJLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLEtBQUssTUFBTSxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQzlELE1BQUEsQ0FBQztJQUNKLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDRyxHQUFHLENBQUMsQ0FBWSxFQUFFLFFBQW1CLEVBQUUsR0FBYzs7O1lBQ3pELElBQUksQ0FBQyxFQUFFLENBQUM7Z0JBQ04sSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLEVBQUUsUUFBUSxFQUFFLEdBQUcsQ0FBQyxDQUFDO1lBQzlCLENBQUM7WUFDRCxJQUFJLHVCQUFBLElBQUksMEJBQVEsSUFBSSx1QkFBQSxJQUFJLDBCQUFRLEVBQUUsQ0FBQztnQkFDakMsT0FBTztZQUNULENBQUM7WUFDRCxJQUFJLEdBQUcsR0FBcUIsSUFBSSxDQUFDO1lBQ2pDLEtBQUssSUFBSSxDQUFDLElBQUksdUJBQUEsSUFBSSx5QkFBTyxFQUFFLENBQUM7Z0JBQzFCLElBQUksQ0FBQyxDQUFDLE1BQU0sSUFBSSxNQUFNLEVBQUUsQ0FBQztvQkFDdkIsR0FBRyxHQUFHLENBQUMsQ0FBQztvQkFDUixNQUFNO2dCQUNSLENBQUM7WUFDSCxDQUFDO1lBQ0QsSUFBSSxHQUFHLEVBQUUsQ0FBQztnQkFDUixJQUFJLElBQUksR0FBUSxJQUFJLENBQUM7Z0JBQ3JCLElBQUksQ0FBQztvQkFDSCx1QkFBQSxJQUFJLHNCQUFXLEtBQUssTUFBQSxDQUFDO29CQUNyQixHQUFHLENBQUMsTUFBTSxHQUFHLEtBQUssQ0FBQztvQkFDbkIsaURBQUEsQ0FBQSwwREFBWSxFQUFaLElBQWMsSUFBQSxDQUFBLE1BQUEsQ0FBQztvQkFDZixJQUFJLEdBQUcsTUFBTSxHQUFHLENBQUMsTUFBTSxFQUFFLENBQUM7b0JBQzFCLElBQUksR0FBRyxDQUFDLFFBQVEsWUFBWSxRQUFRLEVBQUUsQ0FBQzt3QkFDckMsR0FBRyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsQ0FBQztvQkFDckIsQ0FBQztvQkFDRCxHQUFHLENBQUMsTUFBTSxHQUFHLEtBQUssQ0FBQztnQkFDckIsQ0FBQztnQkFBQyxPQUFPLENBQUMsRUFBRSxDQUFDO29CQUNYLElBQUksR0FBRyxDQUFDLEdBQUcsWUFBWSxRQUFRLEVBQUUsQ0FBQzt3QkFDaEMsSUFBSSxHQUFHLENBQUMsS0FBSyxHQUFHLENBQUMsRUFBRSxDQUFDOzRCQUNsQixHQUFHLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQzs0QkFDcEIsR0FBRyxDQUFDLEtBQUssRUFBRSxDQUFDO3dCQUNkLENBQUM7NkJBQU0sQ0FBQzs0QkFDTixHQUFHLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDOzRCQUNYLEdBQUcsQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDO3dCQUN0QixDQUFDO29CQUNILENBQUM7Z0JBQ0gsQ0FBQzt3QkFBUyxDQUFDO29CQUNULGlEQUFBLENBQUEsMERBQVksRUFBWixJQUFjLElBQUEsQ0FBQSxNQUFBLENBQUM7b0JBQ2YsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDO2dCQUNiLENBQUM7WUFDSCxDQUFDO2lCQUFNLENBQUM7Z0JBQ04sSUFBSSx1QkFBQSxJQUFJLDBCQUFRLElBQUksS0FBSyxFQUFFLENBQUM7b0JBQzFCLHVCQUFBLElBQUksc0JBQVcsS0FBSyxNQUFBLENBQUM7b0JBQ3JCLHVCQUFBLElBQUksK0JBQWEsTUFBakIsSUFBSSxDQUFlLENBQUM7Z0JBQ3RCLENBQUM7cUJBQUssSUFBRyx1QkFBQSxJQUFJLHlCQUFPLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBQyxDQUFDO29CQUNqQyx1QkFBQSxJQUFJLCtCQUFhLE1BQWpCLElBQUksQ0FBZSxDQUFDO2dCQUN0QixDQUFDO1lBQ0gsQ0FBQztRQUNILENBQUM7S0FBQTtJQUVEOzs7T0FHRztJQUNILFFBQVE7UUFDTixPQUFPLHVCQUFBLElBQUkseUJBQU8sQ0FBQztJQUNyQixDQUFDO0lBRUQ7Ozs7T0FJRztJQUNHLElBQUksQ0FBQyxHQUF5Qjs7WUFDbEMsT0FBTyxNQUFNLElBQUksT0FBTyxDQUF5QixDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsRUFBRTtnQkFDNUQsSUFBSSxDQUFDLEdBQUcsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLEdBQUcsQ0FBQyxDQUFDO1lBQzFCLENBQUMsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztLQUFBO0NBQ0Y7QUFoSUQsZ0NBZ0lDOztBQUVELE1BQU0sWUFBWSxHQUFHLElBQUksT0FBTyxFQUFFLENBQUM7QUFFbkM7Ozs7Ozs7O0dBUUc7QUFDSCxTQUFzQixVQUFVLENBQzlCLFFBQVcsRUFDWCxHQUFHLEtBQW9COztRQUV2QixJQUFJLEdBQUcsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBVyxDQUFDO1FBQzFDLElBQUksWUFBWSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQzFCLE9BQU8sWUFBWSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQWtCLENBQUM7UUFDaEQsQ0FBQztRQUNELElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxRQUFRLENBQUMsR0FBRyxLQUFLLENBQUMsQ0FBa0IsQ0FBQztRQUNwRCxZQUFZLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQ3pCLE9BQU8sQ0FBQyxDQUFDO0lBQ1gsQ0FBQztDQUFBO0FBWEQsZ0NBV0MifQ==
|