#Module abort

AbortController and AbortSignal (DOM Standard). A signal is an EventTarget ("abort"). Its reason is a (code, text) pair: AbortError by default, TimeoutError for AbortSignal.timeout(). Dependent signals (AbortSignal.any) follow their sources as the specification describes.

Exposed to: Window. Source: api/abort.widl.

Odin: import "wren:abort".

#Types

#handle AbortController : Object

Checked by the browser on every call (lookup_AbortController).

#handle AbortSignal : Object

Checked by the browser on every call (lookup_AbortSignal).

#Functions

#AbortController_create

AbortController AbortController_create()

new AbortController()

Host: AbortController_create :: proc(c: ^Call) -> u64

#AbortController_signal

AbortSignal AbortController_signal(AbortController controller)

controller.signal

Host: AbortController_signal :: proc(c: ^Call, controller: Api_AbortController) -> u64

#AbortController_abort

void AbortController_abort(AbortController controller, i64 code = 0, string reason = "")

controller.abort(reason): code 0 and an empty reason give the default AbortError.

Host: AbortController_abort :: proc(c: ^Call, controller: Api_AbortController, code: i64, reason: string)

#AbortSignal_aborted

bool AbortSignal_aborted(AbortSignal signal)

signal.aborted

Host: AbortSignal_aborted :: proc(c: ^Call, signal: Api_AbortSignal) -> bool

#AbortSignal_reasonCode

i64 AbortSignal_reasonCode(AbortSignal signal)

The code of signal.reason (0 while not aborted).

Host: AbortSignal_reasonCode :: proc(c: ^Call, signal: Api_AbortSignal) -> i64

#AbortSignal_reason

string AbortSignal_reason(AbortSignal signal)

The text of signal.reason.

Host: AbortSignal_reason :: proc(c: ^Call, signal: Api_AbortSignal) -> string

#AbortSignal_throwIfAborted

i64 AbortSignal_throwIfAborted(AbortSignal signal)

signal.throwIfAborted(): 0, or the reason's code.

Host: AbortSignal_throwIfAborted :: proc(c: ^Call, signal: Api_AbortSignal) -> i64

#AbortSignal_abort

AbortSignal AbortSignal_abort(i64 code = 0, string reason = "")

AbortSignal.abort(reason): a signal aborted already.

Host: AbortSignal_abort :: proc(c: ^Call, code: i64, reason: string) -> u64

#AbortSignal_timeout

AbortSignal AbortSignal_timeout(f64 ms) raises

AbortSignal.timeout(ms): aborted with TimeoutError after ms. Range for a negative or NaN delay.

Raises: returns an Error (see web).

Host: AbortSignal_timeout :: proc(c: ^Call, ms: f64) -> (u64, Api_Error)

#AbortSignal_any

AbortSignal AbortSignal_any(AbortSignal[] signals) raises

AbortSignal.any(signals). Invalid_Handle when one is not a signal, Range past abort.max_signal_sources.

Raises: returns an Error (see web).

Host: AbortSignal_any :: proc(c: ^Call, signals: []u64) -> (u64, Api_Error)

Edit this page on GitHub