AbortSignal extension type
The AbortSignal interface represents a signal object that allows you
to communicate with an asynchronous operation (such as a fetch request) and
abort it if required via an AbortController object.
- on
- Implemented types
Properties
- aborted → bool
-
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- onabort ↔ EventHandler?
-
getter/setter pair
- reason → JSAny?
-
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addEventListener(
String type, EventListener? callback, [JSAny options]) → void -
The
addEventListener()method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.inherited -
dispatchEvent(
Event event) → bool -
The
dispatchEvent()method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually withdispatchEvent().inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeEventListener(
String type, EventListener? callback, [JSAny options]) → void -
The
removeEventListener()method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.inherited -
throwIfAborted(
) → void -
The
throwIfAborted()method throws the signal's abort AbortSignal.reason if the signal has been aborted; otherwise it does nothing. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
abort(
[JSAny? reason]) → AbortSignal -
any(
JSArray< AbortSignal> signals) → AbortSignal -
timeout(
int milliseconds) → AbortSignal