Skip to content

doc: clarify AbortSignal abort listener guidance #62288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nthbotast wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: clarify AbortSignal abort listener guidance #62288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions doc/api/globals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,10 +176,11 @@ that the `abortSignal.aborted` attribute is `false` before adding an `'abort'`
event listener.

Any event listeners attached to the `AbortSignal` should use the
`{ once: true }` option (or, if using the `EventEmitter` APIs to attach a
listener, use the `once()` method) to ensure that the event listener is
removed as soon as the `'abort'` event is handled. Failure to do so may
result in memory leaks.
`{ once: true }` option (or remove the listener manually) to ensure that the
event listener is removed as soon as the `'abort'` event is handled. Failure
to do so may result in memory leaks. Event listeners should also be removed if
they are no longer needed (for example, if the operation is completed before
the signal is aborted).

### `abortSignal.aborted`

Expand Down