View source

class AbortSignal

package js.html

extends EventTarget

@:build(s.shortcut.ShortcutMacro.mixinBuild())@:native("AbortSignal")

The AbortSignal interface represents a signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object.

Documentation AbortSignal by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:

Variables

read onlyaborted:Bool

A Boolean that indicates whether the request(s) the signal is communicating with is/are aborted (true) or not (false).

onabort:Function

Invoked when an abort_(dom_abort_api) event fires, i.e. when the DOM request(s) the signal is communicating with is/are aborted.

Inherited Variables

Inherited Methods

Defined by EventTarget

addEventListener(type:String, listener:Function, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void

addEventListener(type:String, listener:EventListener, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void

Register an event handler of a specific event type on the EventTarget.

Throws:

null

DOMError

dispatchEvent(event:Event):Bool

Dispatch an event to this EventTarget.

Throws:

null

DOMError

removeEventListener(type:String, listener:Function, ?options:EitherType<EventListenerOptions, Bool>):Void

removeEventListener(type:String, listener:EventListener, ?options:EitherType<EventListenerOptions, Bool>):Void

Removes an event listener from the EventTarget.

Throws:

null

DOMError