Document abortable event listeners #2759
Merged
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
sideshowbarker
requested review from
chrisdavidmills
and removed request for
a team
This patch includes the following changes: - Document the "signal" parameter for the addEventListener() options object - “Add an abortable listener” example code added to addEventListener() article - Add a similar simple example code to he “Introduction to events” guide - In both “Introduction to events” guide and removeEventListener() article, add prose mentions that you can pass an AbortSignal to an addEventListener() call, and abort/cancel/remove the listener by calling abort() on the controller owning the AbortSignal. Related: - whatwg/dom@83037a1 - https://dom.spec.whatwg.org/#dictdef-addeventlisteneroptions - https://dom.spec.whatwg.org/#ref-for-concept-event-listener① - https://dom.spec.whatwg.org/#ref-for-abortsignal③
sideshowbarker
force-pushed
the
sideshowbarker/addeventlistener-abortable
branch
from
93fef08
to
8e31499
Compare
annevk
approved these changes
Feb 28, 2021
|
Looks like another team member / @chrisdavidmills needs to review this before it can be merged. |
chrisdavidmills
approved these changes
Mar 1, 2021
Yup — think it’s good to go |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR includes the following changes:
signalparameter for theaddEventListener()options objectaddEventListener()articleremoveEventListener()article, add prose mentions that you can pass anAbortSignalto anaddEventListener()call, and abort/cancel/remove the listener by callingabort()on the controller owning theAbortSignal.Related:
It also includes some clean-up changes: