@sapphire/async-queue 1.5.3-next.321df01d.0 → 1.5.3-next.38151673
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 +41 -4
- package/dist/cjs/index.cjs +8 -16
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/esm/index.mjs +8 -16
- package/dist/esm/index.mjs.map +1 -1
- package/dist/iife/index.global.js +8 -16
- package/dist/iife/index.global.js.map +1 -1
- package/package.json +13 -11
package/README.md
CHANGED
|
@@ -13,15 +13,19 @@
|
|
|
13
13
|
|
|
14
14
|
</div>
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
**Table of Contents**
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
- [Features](#features)
|
|
19
|
+
- [Installation](#installation)
|
|
20
|
+
- [Usage](#usage)
|
|
21
|
+
- [Buy us some doughnuts](#buy-us-some-doughnuts)
|
|
22
|
+
- [Contributors](#contributors)
|
|
19
23
|
|
|
20
24
|
## Features
|
|
21
25
|
|
|
22
26
|
- Written in TypeScript
|
|
23
27
|
- Bundled with esbuild so it can be used in NodeJS and browsers
|
|
24
|
-
- Offers CommonJS, ESM and UMD bundles
|
|
28
|
+
- Offers CommonJS, ESM, and UMD bundles
|
|
25
29
|
- Fully tested
|
|
26
30
|
|
|
27
31
|
## Installation
|
|
@@ -32,13 +36,46 @@ You can use the following command to install this package, or replace `npm insta
|
|
|
32
36
|
npm install @sapphire/async-queue
|
|
33
37
|
```
|
|
34
38
|
|
|
39
|
+
## Usage
|
|
40
|
+
|
|
41
|
+
**Note**: While this section uses `require`, the imports match 1:1 with ESM imports. For example `const { AsyncQueue } = require('@sapphire/async-queue')` equals `import { AsyncQueue } from '@sapphire/async-queue'`.
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
// Require the AsyncQueue class
|
|
45
|
+
const { AsyncQueue } = require('@sapphire/async-queue');
|
|
46
|
+
|
|
47
|
+
const queue = new AsyncQueue();
|
|
48
|
+
|
|
49
|
+
async function request(url, options) {
|
|
50
|
+
// Wait and lock the queue
|
|
51
|
+
await queue.wait();
|
|
52
|
+
|
|
53
|
+
try {
|
|
54
|
+
// Perform the operation sequentially
|
|
55
|
+
return await fetch(url, options);
|
|
56
|
+
} finally {
|
|
57
|
+
// Unlock the next promise in the queue
|
|
58
|
+
queue.shift();
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
request(someUrl1, someOptions1);
|
|
63
|
+
// Will call fetch() immediately
|
|
64
|
+
|
|
65
|
+
request(someUrl2, someOptions2);
|
|
66
|
+
// Will call fetch() after the first finished
|
|
67
|
+
|
|
68
|
+
request(someUrl3, someOptions3);
|
|
69
|
+
// Will call fetch() after the second finished
|
|
70
|
+
```
|
|
71
|
+
|
|
35
72
|
---
|
|
36
73
|
|
|
37
74
|
## Buy us some doughnuts
|
|
38
75
|
|
|
39
76
|
Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!
|
|
40
77
|
|
|
41
|
-
We accept donations through Open Collective, Ko-fi, PayPal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.
|
|
78
|
+
We accept donations through Open Collective, Ko-fi, PayPal, Patreon, and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.
|
|
42
79
|
|
|
43
80
|
| Donate With | Address |
|
|
44
81
|
| :-------------: | :-------------------------------------------------: |
|
package/dist/cjs/index.cjs
CHANGED
|
@@ -3,12 +3,9 @@
|
|
|
3
3
|
var __defProp = Object.defineProperty;
|
|
4
4
|
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
5
5
|
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
6
|
-
var __publicField = (obj, key, value) =>
|
|
7
|
-
__defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
8
|
-
return value;
|
|
9
|
-
};
|
|
6
|
+
var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
10
7
|
|
|
11
|
-
// src/lib/
|
|
8
|
+
// src/lib/_AsyncQueueEntry.ts
|
|
12
9
|
var _AsyncQueueEntry = class _AsyncQueueEntry {
|
|
13
10
|
constructor(queue) {
|
|
14
11
|
__publicField(this, "promise");
|
|
@@ -24,13 +21,11 @@ var _AsyncQueueEntry = class _AsyncQueueEntry {
|
|
|
24
21
|
});
|
|
25
22
|
}
|
|
26
23
|
setSignal(signal) {
|
|
27
|
-
if (signal.aborted)
|
|
28
|
-
return this;
|
|
24
|
+
if (signal.aborted) return this;
|
|
29
25
|
this.signal = signal;
|
|
30
26
|
this.signalListener = () => {
|
|
31
27
|
const index = this.queue["promises"].indexOf(this);
|
|
32
|
-
if (index !== -1)
|
|
33
|
-
this.queue["promises"].splice(index, 1);
|
|
28
|
+
if (index !== -1) this.queue["promises"].splice(index, 1);
|
|
34
29
|
this.reject(new Error("Request aborted manually"));
|
|
35
30
|
};
|
|
36
31
|
this.signal.addEventListener("abort", this.signalListener);
|
|
@@ -107,16 +102,14 @@ var _AsyncQueue = class _AsyncQueue {
|
|
|
107
102
|
return Promise.resolve();
|
|
108
103
|
}
|
|
109
104
|
this.promises.push(entry);
|
|
110
|
-
if (options?.signal)
|
|
111
|
-
entry.setSignal(options.signal);
|
|
105
|
+
if (options?.signal) entry.setSignal(options.signal);
|
|
112
106
|
return entry.promise;
|
|
113
107
|
}
|
|
114
108
|
/**
|
|
115
109
|
* Unlocks the head lock and transfers the next lock (if any) to the head.
|
|
116
110
|
*/
|
|
117
111
|
shift() {
|
|
118
|
-
if (this.promises.length === 0)
|
|
119
|
-
return;
|
|
112
|
+
if (this.promises.length === 0) return;
|
|
120
113
|
if (this.promises.length === 1) {
|
|
121
114
|
this.promises.shift();
|
|
122
115
|
return;
|
|
@@ -129,8 +122,7 @@ var _AsyncQueue = class _AsyncQueue {
|
|
|
129
122
|
* @note To avoid race conditions, this does **not** unlock the head lock.
|
|
130
123
|
*/
|
|
131
124
|
abortAll() {
|
|
132
|
-
if (this.queued === 0)
|
|
133
|
-
return;
|
|
125
|
+
if (this.queued === 0) return;
|
|
134
126
|
for (let i = 1; i < this.promises.length; ++i) {
|
|
135
127
|
this.promises[i].abort();
|
|
136
128
|
}
|
|
@@ -141,5 +133,5 @@ __name(_AsyncQueue, "AsyncQueue");
|
|
|
141
133
|
var AsyncQueue = _AsyncQueue;
|
|
142
134
|
|
|
143
135
|
exports.AsyncQueue = AsyncQueue;
|
|
144
|
-
//# sourceMappingURL=
|
|
136
|
+
//# sourceMappingURL=index.cjs.map
|
|
145
137
|
//# sourceMappingURL=index.cjs.map
|
package/dist/cjs/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/lib/
|
|
1
|
+
{"version":3,"sources":["../../src/lib/_AsyncQueueEntry.ts","../../src/lib/AsyncQueue.ts"],"names":[],"mappings":";;;;;;;;AAKO,IAAM,gBAAA,GAAN,MAAM,gBAAgB,CAAA;AAAA,EAQrB,YAAY,KAAmB,EAAA;AAPtC,IAAgB,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AAChB,IAAQ,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACR,IAAiB,aAAA,CAAA,IAAA,EAAA,OAAA,CAAA,CAAA;AACjB,IAAA,aAAA,CAAA,IAAA,EAAQ,QAAqC,EAAA,IAAA,CAAA,CAAA;AAC7C,IAAA,aAAA,CAAA,IAAA,EAAQ,gBAAsC,EAAA,IAAA,CAAA,CAAA;AAG7C,IAAA,IAAA,CAAK,KAAQ,GAAA,KAAA,CAAA;AACb,IAAA,IAAA,CAAK,OAAU,GAAA,IAAI,OAAQ,CAAA,CAAC,SAAS,MAAW,KAAA;AAC/C,MAAA,IAAA,CAAK,OAAU,GAAA,OAAA,CAAA;AACf,MAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AAAA,KACd,CAAA,CAAA;AAAA,GACF;AAAA,EAEO,UAAU,MAAqB,EAAA;AACrC,IAAI,IAAA,MAAA,CAAO,SAAgB,OAAA,IAAA,CAAA;AAE3B,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,iBAAiB,MAAM;AAC3B,MAAA,MAAM,QAAQ,IAAK,CAAA,KAAA,CAAM,UAAU,CAAA,CAAE,QAAQ,IAAI,CAAA,CAAA;AACjD,MAAI,IAAA,KAAA,KAAU,IAAS,IAAA,CAAA,KAAA,CAAM,UAAU,CAAE,CAAA,MAAA,CAAO,OAAO,CAAC,CAAA,CAAA;AAExD,MAAA,IAAA,CAAK,MAAO,CAAA,IAAI,KAAM,CAAA,0BAA0B,CAAC,CAAA,CAAA;AAAA,KAClD,CAAA;AACA,IAAA,IAAA,CAAK,MAAO,CAAA,gBAAA,CAAiB,OAAS,EAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AACzD,IAAO,OAAA,IAAA,CAAA;AAAA,GACR;AAAA,EAEO,GAAM,GAAA;AACZ,IAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AACb,IAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AACb,IAAO,OAAA,IAAA,CAAA;AAAA,GACR;AAAA,EAEO,KAAQ,GAAA;AACd,IAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AACb,IAAA,IAAA,CAAK,MAAO,CAAA,IAAI,KAAM,CAAA,0BAA0B,CAAC,CAAA,CAAA;AACjD,IAAO,OAAA,IAAA,CAAA;AAAA,GACR;AAAA,EAEQ,OAAU,GAAA;AACjB,IAAA,IAAI,KAAK,MAAQ,EAAA;AAChB,MAAA,IAAA,CAAK,MAAO,CAAA,mBAAA,CAAoB,OAAS,EAAA,IAAA,CAAK,cAAe,CAAA,CAAA;AAC7D,MAAA,IAAA,CAAK,MAAS,GAAA,IAAA,CAAA;AACd,MAAA,IAAA,CAAK,cAAiB,GAAA,IAAA,CAAA;AAAA,KACvB;AAAA,GACD;AACD,CAAA,CAAA;AAjD6B,MAAA,CAAA,gBAAA,EAAA,iBAAA,CAAA,CAAA;AAAtB,IAAM,eAAN,GAAA,gBAAA,CAAA;;;ACAA,IAAM,WAAA,GAAN,MAAM,WAAW,CAAA;AAAA,EAAjB,WAAA,GAAA;AAoBN;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAQ,YAA8B,EAAC,CAAA,CAAA;AAAA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAfvC,IAAW,SAAoB,GAAA;AAC9B,IAAA,OAAO,KAAK,QAAS,CAAA,MAAA,CAAA;AAAA,GACtB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,MAAiB,GAAA;AAC3B,IAAA,OAAO,IAAK,CAAA,SAAA,KAAc,CAAI,GAAA,CAAA,GAAI,KAAK,SAAY,GAAA,CAAA,CAAA;AAAA,GACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA4BO,KAAK,OAA0D,EAAA;AACrE,IAAM,MAAA,KAAA,GAAQ,IAAI,eAAA,CAAgB,IAAI,CAAA,CAAA;AAEtC,IAAI,IAAA,IAAA,CAAK,QAAS,CAAA,MAAA,KAAW,CAAG,EAAA;AAC/B,MAAK,IAAA,CAAA,QAAA,CAAS,KAAK,KAAK,CAAA,CAAA;AACxB,MAAA,OAAO,QAAQ,OAAQ,EAAA,CAAA;AAAA,KACxB;AAEA,IAAK,IAAA,CAAA,QAAA,CAAS,KAAK,KAAK,CAAA,CAAA;AACxB,IAAA,IAAI,OAAS,EAAA,MAAA,EAAc,KAAA,CAAA,SAAA,CAAU,QAAQ,MAAM,CAAA,CAAA;AACnD,IAAA,OAAO,KAAM,CAAA,OAAA,CAAA;AAAA,GACd;AAAA;AAAA;AAAA;AAAA,EAKO,KAAc,GAAA;AACpB,IAAI,IAAA,IAAA,CAAK,QAAS,CAAA,MAAA,KAAW,CAAG,EAAA,OAAA;AAChC,IAAI,IAAA,IAAA,CAAK,QAAS,CAAA,MAAA,KAAW,CAAG,EAAA;AAE/B,MAAA,IAAA,CAAK,SAAS,KAAM,EAAA,CAAA;AACpB,MAAA,OAAA;AAAA,KACD;AAIA,IAAA,IAAA,CAAK,SAAS,KAAM,EAAA,CAAA;AACpB,IAAK,IAAA,CAAA,QAAA,CAAS,CAAC,CAAA,CAAE,GAAI,EAAA,CAAA;AAAA,GACtB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,QAAiB,GAAA;AAEvB,IAAI,IAAA,IAAA,CAAK,WAAW,CAAG,EAAA,OAAA;AAIvB,IAAA,KAAA,IAAS,IAAI,CAAG,EAAA,CAAA,GAAI,KAAK,QAAS,CAAA,MAAA,EAAQ,EAAE,CAAG,EAAA;AAC9C,MAAK,IAAA,CAAA,QAAA,CAAS,CAAC,CAAA,CAAE,KAAM,EAAA,CAAA;AAAA,KACxB;AAEA,IAAA,IAAA,CAAK,SAAS,MAAS,GAAA,CAAA,CAAA;AAAA,GACxB;AACD,CAAA,CAAA;AAzFwB,MAAA,CAAA,WAAA,EAAA,YAAA,CAAA,CAAA;AAAjB,IAAM,UAAN,GAAA","file":"index.cjs","sourcesContent":["import type { AsyncQueue } from './AsyncQueue';\n\n/**\n * @internal\n */\nexport class AsyncQueueEntry {\n\tpublic readonly promise: Promise<void>;\n\tprivate resolve!: () => void;\n\tprivate reject!: (error: Error) => void;\n\tprivate readonly queue: AsyncQueue;\n\tprivate signal: PolyFillAbortSignal | null = null;\n\tprivate signalListener: (() => void) | null = null;\n\n\tpublic constructor(queue: AsyncQueue) {\n\t\tthis.queue = queue;\n\t\tthis.promise = new Promise((resolve, reject) => {\n\t\t\tthis.resolve = resolve;\n\t\t\tthis.reject = reject;\n\t\t});\n\t}\n\n\tpublic setSignal(signal: AbortSignal) {\n\t\tif (signal.aborted) return this;\n\n\t\tthis.signal = signal as PolyFillAbortSignal;\n\t\tthis.signalListener = () => {\n\t\t\tconst index = this.queue['promises'].indexOf(this);\n\t\t\tif (index !== -1) this.queue['promises'].splice(index, 1);\n\n\t\t\tthis.reject(new Error('Request aborted manually'));\n\t\t};\n\t\tthis.signal.addEventListener('abort', this.signalListener);\n\t\treturn this;\n\t}\n\n\tpublic use() {\n\t\tthis.dispose();\n\t\tthis.resolve();\n\t\treturn this;\n\t}\n\n\tpublic abort() {\n\t\tthis.dispose();\n\t\tthis.reject(new Error('Request aborted manually'));\n\t\treturn this;\n\t}\n\n\tprivate dispose() {\n\t\tif (this.signal) {\n\t\t\tthis.signal.removeEventListener('abort', this.signalListener!);\n\t\t\tthis.signal = null;\n\t\t\tthis.signalListener = null;\n\t\t}\n\t}\n}\n\ninterface PolyFillAbortSignal {\n\treadonly aborted: boolean;\n\taddEventListener(type: 'abort', listener: () => void): void;\n\tremoveEventListener(type: 'abort', listener: () => void): void;\n}\n","import { AsyncQueueEntry } from './_AsyncQueueEntry';\n\n/**\n * The AsyncQueue class used to sequentialize burst requests\n */\nexport class AsyncQueue {\n\t/**\n\t * The amount of entries in the queue, including the head.\n\t * @seealso {@link queued} for the queued count.\n\t */\n\tpublic get remaining(): number {\n\t\treturn this.promises.length;\n\t}\n\n\t/**\n\t * The amount of queued entries.\n\t * @seealso {@link remaining} for the count with the head.\n\t */\n\tpublic get queued(): number {\n\t\treturn this.remaining === 0 ? 0 : this.remaining - 1;\n\t}\n\n\t/**\n\t * The promises array\n\t */\n\tprivate promises: AsyncQueueEntry[] = [];\n\n\t/**\n\t * Waits for last promise and queues a new one\n\t * @example\n\t * ```typescript\n\t * const queue = new AsyncQueue();\n\t * async function request(url, options) {\n\t * await queue.wait({ signal: options.signal });\n\t * try {\n\t * const result = await fetch(url, options);\n\t * // Do some operations with 'result'\n\t * } finally {\n\t * // Remove first entry from the queue and resolve for the next entry\n\t * queue.shift();\n\t * }\n\t * }\n\t *\n\t * request(someUrl1, someOptions1); // Will call fetch() immediately\n\t * request(someUrl2, someOptions2); // Will call fetch() after the first finished\n\t * request(someUrl3, someOptions3); // Will call fetch() after the second finished\n\t * ```\n\t */\n\tpublic wait(options?: Readonly<AsyncQueueWaitOptions>): Promise<void> {\n\t\tconst entry = new AsyncQueueEntry(this);\n\n\t\tif (this.promises.length === 0) {\n\t\t\tthis.promises.push(entry);\n\t\t\treturn Promise.resolve();\n\t\t}\n\n\t\tthis.promises.push(entry);\n\t\tif (options?.signal) entry.setSignal(options.signal);\n\t\treturn entry.promise;\n\t}\n\n\t/**\n\t * Unlocks the head lock and transfers the next lock (if any) to the head.\n\t */\n\tpublic shift(): void {\n\t\tif (this.promises.length === 0) return;\n\t\tif (this.promises.length === 1) {\n\t\t\t// Remove the head entry.\n\t\t\tthis.promises.shift();\n\t\t\treturn;\n\t\t}\n\n\t\t// Remove the head entry, making the 2nd entry the new one.\n\t\t// Then use the head entry, which will unlock the promise.\n\t\tthis.promises.shift();\n\t\tthis.promises[0].use();\n\t}\n\n\t/**\n\t * Aborts all the pending promises.\n\t * @note To avoid race conditions, this does **not** unlock the head lock.\n\t */\n\tpublic abortAll(): void {\n\t\t// If there are no queued entries, skip early.\n\t\tif (this.queued === 0) return;\n\n\t\t// Abort all the entries except the head, that is why the loop starts at\n\t\t// 1 and not at 0.\n\t\tfor (let i = 1; i < this.promises.length; ++i) {\n\t\t\tthis.promises[i].abort();\n\t\t}\n\n\t\tthis.promises.length = 1;\n\t}\n}\n\nexport interface AsyncQueueWaitOptions {\n\tsignal?: AbortSignal | undefined | null;\n}\n"]}
|
package/dist/esm/index.mjs
CHANGED
|
@@ -1,12 +1,9 @@
|
|
|
1
1
|
var __defProp = Object.defineProperty;
|
|
2
2
|
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
3
3
|
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
4
|
-
var __publicField = (obj, key, value) =>
|
|
5
|
-
__defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
6
|
-
return value;
|
|
7
|
-
};
|
|
4
|
+
var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
8
5
|
|
|
9
|
-
// src/lib/
|
|
6
|
+
// src/lib/_AsyncQueueEntry.ts
|
|
10
7
|
var _AsyncQueueEntry = class _AsyncQueueEntry {
|
|
11
8
|
constructor(queue) {
|
|
12
9
|
__publicField(this, "promise");
|
|
@@ -22,13 +19,11 @@ var _AsyncQueueEntry = class _AsyncQueueEntry {
|
|
|
22
19
|
});
|
|
23
20
|
}
|
|
24
21
|
setSignal(signal) {
|
|
25
|
-
if (signal.aborted)
|
|
26
|
-
return this;
|
|
22
|
+
if (signal.aborted) return this;
|
|
27
23
|
this.signal = signal;
|
|
28
24
|
this.signalListener = () => {
|
|
29
25
|
const index = this.queue["promises"].indexOf(this);
|
|
30
|
-
if (index !== -1)
|
|
31
|
-
this.queue["promises"].splice(index, 1);
|
|
26
|
+
if (index !== -1) this.queue["promises"].splice(index, 1);
|
|
32
27
|
this.reject(new Error("Request aborted manually"));
|
|
33
28
|
};
|
|
34
29
|
this.signal.addEventListener("abort", this.signalListener);
|
|
@@ -105,16 +100,14 @@ var _AsyncQueue = class _AsyncQueue {
|
|
|
105
100
|
return Promise.resolve();
|
|
106
101
|
}
|
|
107
102
|
this.promises.push(entry);
|
|
108
|
-
if (options?.signal)
|
|
109
|
-
entry.setSignal(options.signal);
|
|
103
|
+
if (options?.signal) entry.setSignal(options.signal);
|
|
110
104
|
return entry.promise;
|
|
111
105
|
}
|
|
112
106
|
/**
|
|
113
107
|
* Unlocks the head lock and transfers the next lock (if any) to the head.
|
|
114
108
|
*/
|
|
115
109
|
shift() {
|
|
116
|
-
if (this.promises.length === 0)
|
|
117
|
-
return;
|
|
110
|
+
if (this.promises.length === 0) return;
|
|
118
111
|
if (this.promises.length === 1) {
|
|
119
112
|
this.promises.shift();
|
|
120
113
|
return;
|
|
@@ -127,8 +120,7 @@ var _AsyncQueue = class _AsyncQueue {
|
|
|
127
120
|
* @note To avoid race conditions, this does **not** unlock the head lock.
|
|
128
121
|
*/
|
|
129
122
|
abortAll() {
|
|
130
|
-
if (this.queued === 0)
|
|
131
|
-
return;
|
|
123
|
+
if (this.queued === 0) return;
|
|
132
124
|
for (let i = 1; i < this.promises.length; ++i) {
|
|
133
125
|
this.promises[i].abort();
|
|
134
126
|
}
|
|
@@ -139,5 +131,5 @@ __name(_AsyncQueue, "AsyncQueue");
|
|
|
139
131
|
var AsyncQueue = _AsyncQueue;
|
|
140
132
|
|
|
141
133
|
export { AsyncQueue };
|
|
142
|
-
//# sourceMappingURL=
|
|
134
|
+
//# sourceMappingURL=index.mjs.map
|
|
143
135
|
//# sourceMappingURL=index.mjs.map
|
package/dist/esm/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/lib/
|
|
1
|
+
{"version":3,"sources":["../../src/lib/_AsyncQueueEntry.ts","../../src/lib/AsyncQueue.ts"],"names":[],"mappings":";;;;;;AAKO,IAAM,gBAAA,GAAN,MAAM,gBAAgB,CAAA;AAAA,EAQrB,YAAY,KAAmB,EAAA;AAPtC,IAAgB,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AAChB,IAAQ,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AACR,IAAiB,aAAA,CAAA,IAAA,EAAA,OAAA,CAAA,CAAA;AACjB,IAAA,aAAA,CAAA,IAAA,EAAQ,QAAqC,EAAA,IAAA,CAAA,CAAA;AAC7C,IAAA,aAAA,CAAA,IAAA,EAAQ,gBAAsC,EAAA,IAAA,CAAA,CAAA;AAG7C,IAAA,IAAA,CAAK,KAAQ,GAAA,KAAA,CAAA;AACb,IAAA,IAAA,CAAK,OAAU,GAAA,IAAI,OAAQ,CAAA,CAAC,SAAS,MAAW,KAAA;AAC/C,MAAA,IAAA,CAAK,OAAU,GAAA,OAAA,CAAA;AACf,MAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AAAA,KACd,CAAA,CAAA;AAAA,GACF;AAAA,EAEO,UAAU,MAAqB,EAAA;AACrC,IAAI,IAAA,MAAA,CAAO,SAAgB,OAAA,IAAA,CAAA;AAE3B,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,iBAAiB,MAAM;AAC3B,MAAA,MAAM,QAAQ,IAAK,CAAA,KAAA,CAAM,UAAU,CAAA,CAAE,QAAQ,IAAI,CAAA,CAAA;AACjD,MAAI,IAAA,KAAA,KAAU,IAAS,IAAA,CAAA,KAAA,CAAM,UAAU,CAAE,CAAA,MAAA,CAAO,OAAO,CAAC,CAAA,CAAA;AAExD,MAAA,IAAA,CAAK,MAAO,CAAA,IAAI,KAAM,CAAA,0BAA0B,CAAC,CAAA,CAAA;AAAA,KAClD,CAAA;AACA,IAAA,IAAA,CAAK,MAAO,CAAA,gBAAA,CAAiB,OAAS,EAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AACzD,IAAO,OAAA,IAAA,CAAA;AAAA,GACR;AAAA,EAEO,GAAM,GAAA;AACZ,IAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AACb,IAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AACb,IAAO,OAAA,IAAA,CAAA;AAAA,GACR;AAAA,EAEO,KAAQ,GAAA;AACd,IAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AACb,IAAA,IAAA,CAAK,MAAO,CAAA,IAAI,KAAM,CAAA,0BAA0B,CAAC,CAAA,CAAA;AACjD,IAAO,OAAA,IAAA,CAAA;AAAA,GACR;AAAA,EAEQ,OAAU,GAAA;AACjB,IAAA,IAAI,KAAK,MAAQ,EAAA;AAChB,MAAA,IAAA,CAAK,MAAO,CAAA,mBAAA,CAAoB,OAAS,EAAA,IAAA,CAAK,cAAe,CAAA,CAAA;AAC7D,MAAA,IAAA,CAAK,MAAS,GAAA,IAAA,CAAA;AACd,MAAA,IAAA,CAAK,cAAiB,GAAA,IAAA,CAAA;AAAA,KACvB;AAAA,GACD;AACD,CAAA,CAAA;AAjD6B,MAAA,CAAA,gBAAA,EAAA,iBAAA,CAAA,CAAA;AAAtB,IAAM,eAAN,GAAA,gBAAA,CAAA;;;ACAA,IAAM,WAAA,GAAN,MAAM,WAAW,CAAA;AAAA,EAAjB,WAAA,GAAA;AAoBN;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAQ,YAA8B,EAAC,CAAA,CAAA;AAAA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAfvC,IAAW,SAAoB,GAAA;AAC9B,IAAA,OAAO,KAAK,QAAS,CAAA,MAAA,CAAA;AAAA,GACtB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,MAAiB,GAAA;AAC3B,IAAA,OAAO,IAAK,CAAA,SAAA,KAAc,CAAI,GAAA,CAAA,GAAI,KAAK,SAAY,GAAA,CAAA,CAAA;AAAA,GACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA4BO,KAAK,OAA0D,EAAA;AACrE,IAAM,MAAA,KAAA,GAAQ,IAAI,eAAA,CAAgB,IAAI,CAAA,CAAA;AAEtC,IAAI,IAAA,IAAA,CAAK,QAAS,CAAA,MAAA,KAAW,CAAG,EAAA;AAC/B,MAAK,IAAA,CAAA,QAAA,CAAS,KAAK,KAAK,CAAA,CAAA;AACxB,MAAA,OAAO,QAAQ,OAAQ,EAAA,CAAA;AAAA,KACxB;AAEA,IAAK,IAAA,CAAA,QAAA,CAAS,KAAK,KAAK,CAAA,CAAA;AACxB,IAAA,IAAI,OAAS,EAAA,MAAA,EAAc,KAAA,CAAA,SAAA,CAAU,QAAQ,MAAM,CAAA,CAAA;AACnD,IAAA,OAAO,KAAM,CAAA,OAAA,CAAA;AAAA,GACd;AAAA;AAAA;AAAA;AAAA,EAKO,KAAc,GAAA;AACpB,IAAI,IAAA,IAAA,CAAK,QAAS,CAAA,MAAA,KAAW,CAAG,EAAA,OAAA;AAChC,IAAI,IAAA,IAAA,CAAK,QAAS,CAAA,MAAA,KAAW,CAAG,EAAA;AAE/B,MAAA,IAAA,CAAK,SAAS,KAAM,EAAA,CAAA;AACpB,MAAA,OAAA;AAAA,KACD;AAIA,IAAA,IAAA,CAAK,SAAS,KAAM,EAAA,CAAA;AACpB,IAAK,IAAA,CAAA,QAAA,CAAS,CAAC,CAAA,CAAE,GAAI,EAAA,CAAA;AAAA,GACtB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,QAAiB,GAAA;AAEvB,IAAI,IAAA,IAAA,CAAK,WAAW,CAAG,EAAA,OAAA;AAIvB,IAAA,KAAA,IAAS,IAAI,CAAG,EAAA,CAAA,GAAI,KAAK,QAAS,CAAA,MAAA,EAAQ,EAAE,CAAG,EAAA;AAC9C,MAAK,IAAA,CAAA,QAAA,CAAS,CAAC,CAAA,CAAE,KAAM,EAAA,CAAA;AAAA,KACxB;AAEA,IAAA,IAAA,CAAK,SAAS,MAAS,GAAA,CAAA,CAAA;AAAA,GACxB;AACD,CAAA,CAAA;AAzFwB,MAAA,CAAA,WAAA,EAAA,YAAA,CAAA,CAAA;AAAjB,IAAM,UAAN,GAAA","file":"index.mjs","sourcesContent":["import type { AsyncQueue } from './AsyncQueue';\n\n/**\n * @internal\n */\nexport class AsyncQueueEntry {\n\tpublic readonly promise: Promise<void>;\n\tprivate resolve!: () => void;\n\tprivate reject!: (error: Error) => void;\n\tprivate readonly queue: AsyncQueue;\n\tprivate signal: PolyFillAbortSignal | null = null;\n\tprivate signalListener: (() => void) | null = null;\n\n\tpublic constructor(queue: AsyncQueue) {\n\t\tthis.queue = queue;\n\t\tthis.promise = new Promise((resolve, reject) => {\n\t\t\tthis.resolve = resolve;\n\t\t\tthis.reject = reject;\n\t\t});\n\t}\n\n\tpublic setSignal(signal: AbortSignal) {\n\t\tif (signal.aborted) return this;\n\n\t\tthis.signal = signal as PolyFillAbortSignal;\n\t\tthis.signalListener = () => {\n\t\t\tconst index = this.queue['promises'].indexOf(this);\n\t\t\tif (index !== -1) this.queue['promises'].splice(index, 1);\n\n\t\t\tthis.reject(new Error('Request aborted manually'));\n\t\t};\n\t\tthis.signal.addEventListener('abort', this.signalListener);\n\t\treturn this;\n\t}\n\n\tpublic use() {\n\t\tthis.dispose();\n\t\tthis.resolve();\n\t\treturn this;\n\t}\n\n\tpublic abort() {\n\t\tthis.dispose();\n\t\tthis.reject(new Error('Request aborted manually'));\n\t\treturn this;\n\t}\n\n\tprivate dispose() {\n\t\tif (this.signal) {\n\t\t\tthis.signal.removeEventListener('abort', this.signalListener!);\n\t\t\tthis.signal = null;\n\t\t\tthis.signalListener = null;\n\t\t}\n\t}\n}\n\ninterface PolyFillAbortSignal {\n\treadonly aborted: boolean;\n\taddEventListener(type: 'abort', listener: () => void): void;\n\tremoveEventListener(type: 'abort', listener: () => void): void;\n}\n","import { AsyncQueueEntry } from './_AsyncQueueEntry';\n\n/**\n * The AsyncQueue class used to sequentialize burst requests\n */\nexport class AsyncQueue {\n\t/**\n\t * The amount of entries in the queue, including the head.\n\t * @seealso {@link queued} for the queued count.\n\t */\n\tpublic get remaining(): number {\n\t\treturn this.promises.length;\n\t}\n\n\t/**\n\t * The amount of queued entries.\n\t * @seealso {@link remaining} for the count with the head.\n\t */\n\tpublic get queued(): number {\n\t\treturn this.remaining === 0 ? 0 : this.remaining - 1;\n\t}\n\n\t/**\n\t * The promises array\n\t */\n\tprivate promises: AsyncQueueEntry[] = [];\n\n\t/**\n\t * Waits for last promise and queues a new one\n\t * @example\n\t * ```typescript\n\t * const queue = new AsyncQueue();\n\t * async function request(url, options) {\n\t * await queue.wait({ signal: options.signal });\n\t * try {\n\t * const result = await fetch(url, options);\n\t * // Do some operations with 'result'\n\t * } finally {\n\t * // Remove first entry from the queue and resolve for the next entry\n\t * queue.shift();\n\t * }\n\t * }\n\t *\n\t * request(someUrl1, someOptions1); // Will call fetch() immediately\n\t * request(someUrl2, someOptions2); // Will call fetch() after the first finished\n\t * request(someUrl3, someOptions3); // Will call fetch() after the second finished\n\t * ```\n\t */\n\tpublic wait(options?: Readonly<AsyncQueueWaitOptions>): Promise<void> {\n\t\tconst entry = new AsyncQueueEntry(this);\n\n\t\tif (this.promises.length === 0) {\n\t\t\tthis.promises.push(entry);\n\t\t\treturn Promise.resolve();\n\t\t}\n\n\t\tthis.promises.push(entry);\n\t\tif (options?.signal) entry.setSignal(options.signal);\n\t\treturn entry.promise;\n\t}\n\n\t/**\n\t * Unlocks the head lock and transfers the next lock (if any) to the head.\n\t */\n\tpublic shift(): void {\n\t\tif (this.promises.length === 0) return;\n\t\tif (this.promises.length === 1) {\n\t\t\t// Remove the head entry.\n\t\t\tthis.promises.shift();\n\t\t\treturn;\n\t\t}\n\n\t\t// Remove the head entry, making the 2nd entry the new one.\n\t\t// Then use the head entry, which will unlock the promise.\n\t\tthis.promises.shift();\n\t\tthis.promises[0].use();\n\t}\n\n\t/**\n\t * Aborts all the pending promises.\n\t * @note To avoid race conditions, this does **not** unlock the head lock.\n\t */\n\tpublic abortAll(): void {\n\t\t// If there are no queued entries, skip early.\n\t\tif (this.queued === 0) return;\n\n\t\t// Abort all the entries except the head, that is why the loop starts at\n\t\t// 1 and not at 0.\n\t\tfor (let i = 1; i < this.promises.length; ++i) {\n\t\t\tthis.promises[i].abort();\n\t\t}\n\n\t\tthis.promises.length = 1;\n\t}\n}\n\nexport interface AsyncQueueWaitOptions {\n\tsignal?: AbortSignal | undefined | null;\n}\n"]}
|
|
@@ -4,12 +4,9 @@ var SapphireAsyncQueue = (function (exports) {
|
|
|
4
4
|
var __defProp = Object.defineProperty;
|
|
5
5
|
var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
6
6
|
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
7
|
-
var __publicField = (obj, key, value) =>
|
|
8
|
-
__defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
9
|
-
return value;
|
|
10
|
-
};
|
|
7
|
+
var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
|
|
11
8
|
|
|
12
|
-
// src/lib/
|
|
9
|
+
// src/lib/_AsyncQueueEntry.ts
|
|
13
10
|
var _AsyncQueueEntry = class _AsyncQueueEntry {
|
|
14
11
|
constructor(queue) {
|
|
15
12
|
__publicField(this, "promise");
|
|
@@ -25,13 +22,11 @@ var SapphireAsyncQueue = (function (exports) {
|
|
|
25
22
|
});
|
|
26
23
|
}
|
|
27
24
|
setSignal(signal) {
|
|
28
|
-
if (signal.aborted)
|
|
29
|
-
return this;
|
|
25
|
+
if (signal.aborted) return this;
|
|
30
26
|
this.signal = signal;
|
|
31
27
|
this.signalListener = () => {
|
|
32
28
|
const index = this.queue["promises"].indexOf(this);
|
|
33
|
-
if (index !== -1)
|
|
34
|
-
this.queue["promises"].splice(index, 1);
|
|
29
|
+
if (index !== -1) this.queue["promises"].splice(index, 1);
|
|
35
30
|
this.reject(new Error("Request aborted manually"));
|
|
36
31
|
};
|
|
37
32
|
this.signal.addEventListener("abort", this.signalListener);
|
|
@@ -108,16 +103,14 @@ var SapphireAsyncQueue = (function (exports) {
|
|
|
108
103
|
return Promise.resolve();
|
|
109
104
|
}
|
|
110
105
|
this.promises.push(entry);
|
|
111
|
-
if (options?.signal)
|
|
112
|
-
entry.setSignal(options.signal);
|
|
106
|
+
if (options?.signal) entry.setSignal(options.signal);
|
|
113
107
|
return entry.promise;
|
|
114
108
|
}
|
|
115
109
|
/**
|
|
116
110
|
* Unlocks the head lock and transfers the next lock (if any) to the head.
|
|
117
111
|
*/
|
|
118
112
|
shift() {
|
|
119
|
-
if (this.promises.length === 0)
|
|
120
|
-
return;
|
|
113
|
+
if (this.promises.length === 0) return;
|
|
121
114
|
if (this.promises.length === 1) {
|
|
122
115
|
this.promises.shift();
|
|
123
116
|
return;
|
|
@@ -130,8 +123,7 @@ var SapphireAsyncQueue = (function (exports) {
|
|
|
130
123
|
* @note To avoid race conditions, this does **not** unlock the head lock.
|
|
131
124
|
*/
|
|
132
125
|
abortAll() {
|
|
133
|
-
if (this.queued === 0)
|
|
134
|
-
return;
|
|
126
|
+
if (this.queued === 0) return;
|
|
135
127
|
for (let i = 1; i < this.promises.length; ++i) {
|
|
136
128
|
this.promises[i].abort();
|
|
137
129
|
}
|
|
@@ -146,5 +138,5 @@ var SapphireAsyncQueue = (function (exports) {
|
|
|
146
138
|
return exports;
|
|
147
139
|
|
|
148
140
|
})({});
|
|
149
|
-
//# sourceMappingURL=
|
|
141
|
+
//# sourceMappingURL=index.global.js.map
|
|
150
142
|
//# sourceMappingURL=index.global.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/lib/
|
|
1
|
+
{"version":3,"sources":["../../src/lib/_AsyncQueueEntry.ts","../../src/lib/AsyncQueue.ts"],"names":[],"mappings":";;;;;;;;;EAKO,IAAM,gBAAA,GAAN,MAAM,gBAAgB,CAAA;EAAA,EAQrB,YAAY,KAAmB,EAAA;EAPtC,IAAgB,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;EAChB,IAAQ,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;EACR,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;EACR,IAAiB,aAAA,CAAA,IAAA,EAAA,OAAA,CAAA,CAAA;EACjB,IAAA,aAAA,CAAA,IAAA,EAAQ,QAAqC,EAAA,IAAA,CAAA,CAAA;EAC7C,IAAA,aAAA,CAAA,IAAA,EAAQ,gBAAsC,EAAA,IAAA,CAAA,CAAA;EAG7C,IAAA,IAAA,CAAK,KAAQ,GAAA,KAAA,CAAA;EACb,IAAA,IAAA,CAAK,OAAU,GAAA,IAAI,OAAQ,CAAA,CAAC,SAAS,MAAW,KAAA;EAC/C,MAAA,IAAA,CAAK,OAAU,GAAA,OAAA,CAAA;EACf,MAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;EAAA,KACd,CAAA,CAAA;EAAA,GACF;EAAA,EAEO,UAAU,MAAqB,EAAA;EACrC,IAAI,IAAA,MAAA,CAAO,SAAgB,OAAA,IAAA,CAAA;EAE3B,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;EACd,IAAA,IAAA,CAAK,iBAAiB,MAAM;EAC3B,MAAA,MAAM,QAAQ,IAAK,CAAA,KAAA,CAAM,UAAU,CAAA,CAAE,QAAQ,IAAI,CAAA,CAAA;EACjD,MAAI,IAAA,KAAA,KAAU,IAAS,IAAA,CAAA,KAAA,CAAM,UAAU,CAAE,CAAA,MAAA,CAAO,OAAO,CAAC,CAAA,CAAA;EAExD,MAAA,IAAA,CAAK,MAAO,CAAA,IAAI,KAAM,CAAA,0BAA0B,CAAC,CAAA,CAAA;EAAA,KAClD,CAAA;EACA,IAAA,IAAA,CAAK,MAAO,CAAA,gBAAA,CAAiB,OAAS,EAAA,IAAA,CAAK,cAAc,CAAA,CAAA;EACzD,IAAO,OAAA,IAAA,CAAA;EAAA,GACR;EAAA,EAEO,GAAM,GAAA;EACZ,IAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;EACb,IAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;EACb,IAAO,OAAA,IAAA,CAAA;EAAA,GACR;EAAA,EAEO,KAAQ,GAAA;EACd,IAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;EACb,IAAA,IAAA,CAAK,MAAO,CAAA,IAAI,KAAM,CAAA,0BAA0B,CAAC,CAAA,CAAA;EACjD,IAAO,OAAA,IAAA,CAAA;EAAA,GACR;EAAA,EAEQ,OAAU,GAAA;EACjB,IAAA,IAAI,KAAK,MAAQ,EAAA;EAChB,MAAA,IAAA,CAAK,MAAO,CAAA,mBAAA,CAAoB,OAAS,EAAA,IAAA,CAAK,cAAe,CAAA,CAAA;EAC7D,MAAA,IAAA,CAAK,MAAS,GAAA,IAAA,CAAA;EACd,MAAA,IAAA,CAAK,cAAiB,GAAA,IAAA,CAAA;EAAA,KACvB;EAAA,GACD;EACD,CAAA,CAAA;EAjD6B,MAAA,CAAA,gBAAA,EAAA,iBAAA,CAAA,CAAA;EAAtB,IAAM,eAAN,GAAA,gBAAA,CAAA;;;ECAA,IAAM,WAAA,GAAN,MAAM,WAAW,CAAA;EAAA,EAAjB,WAAA,GAAA;EAoBN;EAAA;EAAA;EAAA,IAAA,aAAA,CAAA,IAAA,EAAQ,YAA8B,EAAC,CAAA,CAAA;EAAA,GAAA;EAAA;EAAA;EAAA;EAAA;EAAA,EAfvC,IAAW,SAAoB,GAAA;EAC9B,IAAA,OAAO,KAAK,QAAS,CAAA,MAAA,CAAA;EAAA,GACtB;EAAA;EAAA;EAAA;EAAA;EAAA,EAMA,IAAW,MAAiB,GAAA;EAC3B,IAAA,OAAO,IAAK,CAAA,SAAA,KAAc,CAAI,GAAA,CAAA,GAAI,KAAK,SAAY,GAAA,CAAA,CAAA;EAAA,GACpD;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA,EA4BO,KAAK,OAA0D,EAAA;EACrE,IAAM,MAAA,KAAA,GAAQ,IAAI,eAAA,CAAgB,IAAI,CAAA,CAAA;EAEtC,IAAI,IAAA,IAAA,CAAK,QAAS,CAAA,MAAA,KAAW,CAAG,EAAA;EAC/B,MAAK,IAAA,CAAA,QAAA,CAAS,KAAK,KAAK,CAAA,CAAA;EACxB,MAAA,OAAO,QAAQ,OAAQ,EAAA,CAAA;EAAA,KACxB;EAEA,IAAK,IAAA,CAAA,QAAA,CAAS,KAAK,KAAK,CAAA,CAAA;EACxB,IAAA,IAAI,OAAS,EAAA,MAAA,EAAc,KAAA,CAAA,SAAA,CAAU,QAAQ,MAAM,CAAA,CAAA;EACnD,IAAA,OAAO,KAAM,CAAA,OAAA,CAAA;EAAA,GACd;EAAA;EAAA;EAAA;EAAA,EAKO,KAAc,GAAA;EACpB,IAAI,IAAA,IAAA,CAAK,QAAS,CAAA,MAAA,KAAW,CAAG,EAAA,OAAA;EAChC,IAAI,IAAA,IAAA,CAAK,QAAS,CAAA,MAAA,KAAW,CAAG,EAAA;EAE/B,MAAA,IAAA,CAAK,SAAS,KAAM,EAAA,CAAA;EACpB,MAAA,OAAA;EAAA,KACD;EAIA,IAAA,IAAA,CAAK,SAAS,KAAM,EAAA,CAAA;EACpB,IAAK,IAAA,CAAA,QAAA,CAAS,CAAC,CAAA,CAAE,GAAI,EAAA,CAAA;EAAA,GACtB;EAAA;EAAA;EAAA;EAAA;EAAA,EAMO,QAAiB,GAAA;EAEvB,IAAI,IAAA,IAAA,CAAK,WAAW,CAAG,EAAA,OAAA;EAIvB,IAAA,KAAA,IAAS,IAAI,CAAG,EAAA,CAAA,GAAI,KAAK,QAAS,CAAA,MAAA,EAAQ,EAAE,CAAG,EAAA;EAC9C,MAAK,IAAA,CAAA,QAAA,CAAS,CAAC,CAAA,CAAE,KAAM,EAAA,CAAA;EAAA,KACxB;EAEA,IAAA,IAAA,CAAK,SAAS,MAAS,GAAA,CAAA,CAAA;EAAA,GACxB;EACD,CAAA,CAAA;EAzFwB,MAAA,CAAA,WAAA,EAAA,YAAA,CAAA,CAAA;AAAjB,MAAM,UAAN,GAAA","file":"index.global.js","sourcesContent":["import type { AsyncQueue } from './AsyncQueue';\n\n/**\n * @internal\n */\nexport class AsyncQueueEntry {\n\tpublic readonly promise: Promise<void>;\n\tprivate resolve!: () => void;\n\tprivate reject!: (error: Error) => void;\n\tprivate readonly queue: AsyncQueue;\n\tprivate signal: PolyFillAbortSignal | null = null;\n\tprivate signalListener: (() => void) | null = null;\n\n\tpublic constructor(queue: AsyncQueue) {\n\t\tthis.queue = queue;\n\t\tthis.promise = new Promise((resolve, reject) => {\n\t\t\tthis.resolve = resolve;\n\t\t\tthis.reject = reject;\n\t\t});\n\t}\n\n\tpublic setSignal(signal: AbortSignal) {\n\t\tif (signal.aborted) return this;\n\n\t\tthis.signal = signal as PolyFillAbortSignal;\n\t\tthis.signalListener = () => {\n\t\t\tconst index = this.queue['promises'].indexOf(this);\n\t\t\tif (index !== -1) this.queue['promises'].splice(index, 1);\n\n\t\t\tthis.reject(new Error('Request aborted manually'));\n\t\t};\n\t\tthis.signal.addEventListener('abort', this.signalListener);\n\t\treturn this;\n\t}\n\n\tpublic use() {\n\t\tthis.dispose();\n\t\tthis.resolve();\n\t\treturn this;\n\t}\n\n\tpublic abort() {\n\t\tthis.dispose();\n\t\tthis.reject(new Error('Request aborted manually'));\n\t\treturn this;\n\t}\n\n\tprivate dispose() {\n\t\tif (this.signal) {\n\t\t\tthis.signal.removeEventListener('abort', this.signalListener!);\n\t\t\tthis.signal = null;\n\t\t\tthis.signalListener = null;\n\t\t}\n\t}\n}\n\ninterface PolyFillAbortSignal {\n\treadonly aborted: boolean;\n\taddEventListener(type: 'abort', listener: () => void): void;\n\tremoveEventListener(type: 'abort', listener: () => void): void;\n}\n","import { AsyncQueueEntry } from './_AsyncQueueEntry';\n\n/**\n * The AsyncQueue class used to sequentialize burst requests\n */\nexport class AsyncQueue {\n\t/**\n\t * The amount of entries in the queue, including the head.\n\t * @seealso {@link queued} for the queued count.\n\t */\n\tpublic get remaining(): number {\n\t\treturn this.promises.length;\n\t}\n\n\t/**\n\t * The amount of queued entries.\n\t * @seealso {@link remaining} for the count with the head.\n\t */\n\tpublic get queued(): number {\n\t\treturn this.remaining === 0 ? 0 : this.remaining - 1;\n\t}\n\n\t/**\n\t * The promises array\n\t */\n\tprivate promises: AsyncQueueEntry[] = [];\n\n\t/**\n\t * Waits for last promise and queues a new one\n\t * @example\n\t * ```typescript\n\t * const queue = new AsyncQueue();\n\t * async function request(url, options) {\n\t * await queue.wait({ signal: options.signal });\n\t * try {\n\t * const result = await fetch(url, options);\n\t * // Do some operations with 'result'\n\t * } finally {\n\t * // Remove first entry from the queue and resolve for the next entry\n\t * queue.shift();\n\t * }\n\t * }\n\t *\n\t * request(someUrl1, someOptions1); // Will call fetch() immediately\n\t * request(someUrl2, someOptions2); // Will call fetch() after the first finished\n\t * request(someUrl3, someOptions3); // Will call fetch() after the second finished\n\t * ```\n\t */\n\tpublic wait(options?: Readonly<AsyncQueueWaitOptions>): Promise<void> {\n\t\tconst entry = new AsyncQueueEntry(this);\n\n\t\tif (this.promises.length === 0) {\n\t\t\tthis.promises.push(entry);\n\t\t\treturn Promise.resolve();\n\t\t}\n\n\t\tthis.promises.push(entry);\n\t\tif (options?.signal) entry.setSignal(options.signal);\n\t\treturn entry.promise;\n\t}\n\n\t/**\n\t * Unlocks the head lock and transfers the next lock (if any) to the head.\n\t */\n\tpublic shift(): void {\n\t\tif (this.promises.length === 0) return;\n\t\tif (this.promises.length === 1) {\n\t\t\t// Remove the head entry.\n\t\t\tthis.promises.shift();\n\t\t\treturn;\n\t\t}\n\n\t\t// Remove the head entry, making the 2nd entry the new one.\n\t\t// Then use the head entry, which will unlock the promise.\n\t\tthis.promises.shift();\n\t\tthis.promises[0].use();\n\t}\n\n\t/**\n\t * Aborts all the pending promises.\n\t * @note To avoid race conditions, this does **not** unlock the head lock.\n\t */\n\tpublic abortAll(): void {\n\t\t// If there are no queued entries, skip early.\n\t\tif (this.queued === 0) return;\n\n\t\t// Abort all the entries except the head, that is why the loop starts at\n\t\t// 1 and not at 0.\n\t\tfor (let i = 1; i < this.promises.length; ++i) {\n\t\t\tthis.promises[i].abort();\n\t\t}\n\n\t\tthis.promises.length = 1;\n\t}\n}\n\nexport interface AsyncQueueWaitOptions {\n\tsignal?: AbortSignal | undefined | null;\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sapphire/async-queue",
|
|
3
|
-
"version": "1.5.3-next.
|
|
3
|
+
"version": "1.5.3-next.38151673",
|
|
4
4
|
"description": "Sequential asynchronous lock-based queue for promises",
|
|
5
5
|
"author": "@sapphire",
|
|
6
6
|
"license": "MIT",
|
|
@@ -26,11 +26,12 @@
|
|
|
26
26
|
"test": "vitest run",
|
|
27
27
|
"lint": "eslint src tests --ext ts --fix -c ../../.eslintrc",
|
|
28
28
|
"docs": "typedoc-json-parser",
|
|
29
|
-
"build": "tsup && yarn build:rename-cjs-index",
|
|
30
|
-
"build:rename-cjs-index": "
|
|
29
|
+
"build": "yarn gen-index && tsup && yarn build:rename-cjs-index",
|
|
30
|
+
"build:rename-cjs-index": "tsx ../../scripts/rename-cjs-index.cts",
|
|
31
31
|
"prepack": "yarn build",
|
|
32
32
|
"bump": "cliff-jumper",
|
|
33
|
-
"check-update": "cliff-jumper --dry-run"
|
|
33
|
+
"check-update": "cliff-jumper --dry-run",
|
|
34
|
+
"gen-index": "tsx ../../scripts/gen-index.cts -w async-queue"
|
|
34
35
|
},
|
|
35
36
|
"repository": {
|
|
36
37
|
"type": "git",
|
|
@@ -61,12 +62,13 @@
|
|
|
61
62
|
"access": "public"
|
|
62
63
|
},
|
|
63
64
|
"devDependencies": {
|
|
64
|
-
"@favware/cliff-jumper": "^
|
|
65
|
-
"@vitest/coverage-v8": "^
|
|
66
|
-
"tsup": "^8.
|
|
67
|
-
"
|
|
68
|
-
"typedoc
|
|
69
|
-
"
|
|
70
|
-
"
|
|
65
|
+
"@favware/cliff-jumper": "^4.0.2",
|
|
66
|
+
"@vitest/coverage-v8": "^2.0.3",
|
|
67
|
+
"tsup": "^8.2.1",
|
|
68
|
+
"tsx": "^4.16.2",
|
|
69
|
+
"typedoc": "^0.25.13",
|
|
70
|
+
"typedoc-json-parser": "^10.0.0",
|
|
71
|
+
"typescript": "~5.4.5",
|
|
72
|
+
"vitest": "^2.0.3"
|
|
71
73
|
}
|
|
72
74
|
}
|