A signal that removes event listeners when an AbortController aborts.
Calling AbortController::signal() returns a signal tied to that controller. When the controller aborts or is destroyed, the library removes every listener registered with that signal.
Pass a controller's signal in AddEventListenerOptions when adding a listener:
document.addEventListener("keydown", OnMenuKey,
{ .signal = menu_listeners.
signal() });
A controller that removes a group of DOM event listeners together.
Definition EventListener.h:452
AbortSignal signal() const
Get the signal to pass in AddEventListenerOptions (signal).
Definition EventListener.h:495
Signal States
- An already aborted signal prevents the listener from being added. Calling addEventListener() with it returns an empty EventListener.
- A default-constructed signal never aborts. Because it doesn't belong to an AbortController, listeners added with it stay active until removed or until their page is gone.
- Note
- Calling aborted() is safe from any thread.
- See also
- dom::AbortController, dom::AddEventListenerOptions, dom::EventListener