AbortSignal

open class AbortSignal : EventTarget(source)

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.

MDN Reference

Types

Companion

object Companion

Properties

aborted

val aborted: Boolean

The aborted read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (true) or not (false).

onabort

var onabort: EventHandler<Event, AbortSignal, AbortSignal>?

MDN Reference

reason

val reason: JsErrorLike?

The reason read-only property returns a JavaScript value that indicates the abort reason.

Functions

dispatchEvent

fun dispatchEvent(event: Event): Boolean

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

throwIfAborted

fun throwIfAborted()

The throwIfAborted() method throws the signal's abort AbortSignal.reason if the signal has been aborted; otherwise it does nothing.

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions? = definedExternally): Observable<T>

MDN Reference