Skip to content
Experimental WebAPI

AbortSignal

Values

abort

Read more on MDN

let abort: (~reason: JSON.t=?) => WebAPI.EventAPI.abortSignal

Parameters

option< JSON.t >

Return type

WebAPI.EventAPI.abortSignal

addEventListener

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture. Read more on MDN

let addEventListener: (
  WebAPI.EventAPI.abortSignal,
  ~type_: WebAPI.EventAPI.eventType,
  ~callback: WebAPI.EventAPI.eventListener<'event>,
  ~options: WebAPI.EventAPI.addEventListenerOptions=?,
) => unit

Parameters

WebAPI.EventAPI.abortSignal WebAPI.EventAPI.eventType WebAPI.EventAPI.eventListener option< WebAPI.EventAPI.addEventListenerOptions >

Return type

unit

addEventListener_useCapture

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture. Read more on MDN

let addEventListener_useCapture: (
  WebAPI.EventAPI.abortSignal,
  ~type_: WebAPI.EventAPI.eventType,
  ~callback: WebAPI.EventAPI.eventListener<'event>,
) => unit

Parameters

WebAPI.EventAPI.abortSignal WebAPI.EventAPI.eventType WebAPI.EventAPI.eventListener

Return type

unit

any

Read more on MDN

let any: array<
  WebAPI.EventAPI.abortSignal,
> => WebAPI.EventAPI.abortSignal

Parameters

array< WebAPI.EventAPI.abortSignal >

Return type

WebAPI.EventAPI.abortSignal

asEventTarget

let asEventTarget: WebAPI.EventAPI.abortSignal => WebAPI.EventAPI.eventTarget

Parameters

WebAPI.EventAPI.abortSignal

Return type

WebAPI.EventAPI.eventTarget

dispatchEvent

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. Read more on MDN

let dispatchEvent: (WebAPI.EventAPI.abortSignal, WebAPI.EventAPI.event) => bool

Parameters

WebAPI.EventAPI.abortSignal WebAPI.EventAPI.event

Return type

bool

removeEventListener

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListener: (
  WebAPI.EventAPI.abortSignal,
  ~type_: WebAPI.EventAPI.eventType,
  ~callback: WebAPI.EventAPI.eventListener<'event>,
  ~options: WebAPI.EventAPI.eventListenerOptions=?,
) => unit

Parameters

WebAPI.EventAPI.abortSignal WebAPI.EventAPI.eventType WebAPI.EventAPI.eventListener option< WebAPI.EventAPI.eventListenerOptions >

Return type

unit

removeEventListener_useCapture

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListener_useCapture: (
  WebAPI.EventAPI.abortSignal,
  ~type_: WebAPI.EventAPI.eventType,
  ~callback: WebAPI.EventAPI.eventListener<'event>,
) => unit

Parameters

WebAPI.EventAPI.abortSignal WebAPI.EventAPI.eventType WebAPI.EventAPI.eventListener

Return type

unit

throwIfAborted

Read more on MDN

let throwIfAborted: WebAPI.EventAPI.abortSignal => unit

Parameters

WebAPI.EventAPI.abortSignal

Return type

unit

timeout

Read more on MDN

let timeout: int => WebAPI.EventAPI.abortSignal

Parameters

int

Return type

WebAPI.EventAPI.abortSignal