feat: support AbortSignal to listen to execution abortion #48
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
krisanalfa
force-pushed
the
feat/abort-signal
branch
from
a2359bd to
2ac3367
Compare
|
|
||
| Type: [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) | ||
|
|
||
| An optional signal to listen for abort events. If the signal becomes aborted, all pending and future calls are rejected with a `pThrottle.AbortError` error. |
There was a problem hiding this comment.
This is not the correct behavior. It should reject with AbortSignal.reason
|
|
||
| t.true(error instanceof AbortError); | ||
| t.true(end() < 100); | ||
| t.true(one === 1); |
Comment on lines
+166
to
+170
| try { | ||
| endValue = await promise; | ||
| } catch (error_) { | ||
| error = error_; | ||
| } |
| @@ -109,6 +109,10 @@ export default function pThrottle({limit, interval, strict, onDelay}) { | |||
| }, | |||
| }); | |||
|
|
|||
| if (signal) { | |||
| signal.addEventListener('abort', throttled.abort); | |||
| } | |||
There was a problem hiding this comment.
You also need to use AbortSignal.throwIfAborted() as early as possible in the function in case the signal was already aborted when this is called.
Comment on lines
+112
to
+114
| if (signal) { | ||
| signal.addEventListener('abort', throttled.abort); | ||
| } |
There was a problem hiding this comment.
Suggested change
| if (signal) { | |
| signal.addEventListener('abort', throttled.abort); | |
| } | |
| signal?.addEventListener('abort', throttled.abort); |
| `AbortSignal` to abort pending executions. All unresolved promises are rejected with a `pThrottle.AbortError` error. | ||
|
|
||
| @example | ||
| ``` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
signaloption to listen to execution abortion. When the signal is aborted, all future and pending calls are aborted.