AbortSignal

class AbortSignal : Abortable, EventTarget, ProxyObject

Abort Signal

Implements AbortSignal and AbortSignal.Factory for use in JavaScript.

Types

Link copied to clipboard
object Companion

Host-side factory methods.

Link copied to clipboard

Properties

Link copied to clipboard
open override val aborted: Boolean

Read-only property indicating whether the signal has been aborted; from MDN:

Link copied to clipboard
open override val reason: Any?

Read-only property indicating the reason the operation was aborted; from MDN:

Functions

Link copied to clipboard
open override fun addEventListener(type: String, listener: EventListener)

Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

open override fun addEventListener(type: String, options: AddEventListenerOptions, listener: EventListener)

Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

open override fun addEventListener(type: String, listener: Value, options: Value?)

Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

Link copied to clipboard
open override fun assignAborted(reason: Any?)

Mark this abort-able object as aborted.

Link copied to clipboard
open override fun dispatchEvent(event: Event): Boolean

Dispatches the event to the list of handlers for Event.type.

Link copied to clipboard
open override fun getMember(key: String): Any?
Link copied to clipboard
open override fun getMemberKeys(): Array<String>
Link copied to clipboard
open override fun hasMember(key: String): Boolean
Link copied to clipboard
open override fun putMember(key: String?, value: Value?)
Link copied to clipboard
open override fun removeEventListener(type: String, listener: EventListener)
open override fun removeEventListener(type: String, listener: Value)
open override fun removeEventListener(type: String, listener: EventListener, options: RemoveEventListenerOptions)
open override fun removeEventListener(type: String, listener: EventListener, options: Value)
open override fun removeEventListener(type: String, listener: Value, options: Value)

Removes the listener from the list of handlers for event type.

Link copied to clipboard
open fun removeMember(key: String): Boolean
Link copied to clipboard
open override fun throwIfAborted()

Throws the AbortSignal's reason for aborting, if aborted; from MDN: