Skip to content
Experimental WebAPI

WebSocket

Values

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.WebSocketsAPI.webSocket,
  ~type_: WebAPI.EventAPI.eventType,
  ~callback: WebAPI.EventAPI.eventListener<'event>,
  ~options: WebAPI.EventAPI.addEventListenerOptions=?,
) => unit

Parameters

WebAPI.WebSocketsAPI.webSocket 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.WebSocketsAPI.webSocket,
  ~type_: WebAPI.EventAPI.eventType,
  ~callback: WebAPI.EventAPI.eventListener<'event>,
) => unit

Parameters

WebAPI.WebSocketsAPI.webSocket WebAPI.EventAPI.eventType WebAPI.EventAPI.eventListener

Return type

unit

asEventTarget

let asEventTarget: WebAPI.WebSocketsAPI.webSocket => WebAPI.EventAPI.eventTarget

Parameters

WebAPI.WebSocketsAPI.webSocket

Return type

WebAPI.EventAPI.eventTarget

close

Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason. Read more on MDN

let close: (
  WebAPI.WebSocketsAPI.webSocket,
  ~code: int=?,
  ~reason: string=?,
) => unit

Parameters

WebAPI.WebSocketsAPI.webSocket option< int > option< string >

Return type

unit

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.WebSocketsAPI.webSocket,
  WebAPI.EventAPI.event,
) => bool

Parameters

WebAPI.WebSocketsAPI.webSocket WebAPI.EventAPI.event

Return type

bool

make

Read more on MDN

let make: (
  ~url: string,
  ~protocols: string=?,
) => WebAPI.WebSocketsAPI.webSocket

Parameters

string option< string >

Return type

WebAPI.WebSocketsAPI.webSocket

make2

Read more on MDN

let make2: (
  ~url: string,
  ~protocols: array<string>=?,
) => WebAPI.WebSocketsAPI.webSocket

Parameters

string option< array< string > >

Return type

WebAPI.WebSocketsAPI.webSocket

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.WebSocketsAPI.webSocket,
  ~type_: WebAPI.EventAPI.eventType,
  ~callback: WebAPI.EventAPI.eventListener<'event>,
  ~options: WebAPI.EventAPI.eventListenerOptions=?,
) => unit

Parameters

WebAPI.WebSocketsAPI.webSocket 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.WebSocketsAPI.webSocket,
  ~type_: WebAPI.EventAPI.eventType,
  ~callback: WebAPI.EventAPI.eventListener<'event>,
) => unit

Parameters

WebAPI.WebSocketsAPI.webSocket WebAPI.EventAPI.eventType WebAPI.EventAPI.eventListener

Return type

unit

send

Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView. Read more on MDN

let send: (WebAPI.WebSocketsAPI.webSocket, DataView.t) => unit

Parameters

WebAPI.WebSocketsAPI.webSocket DataView.t

Return type

unit

send2

Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView. Read more on MDN

let send2: (WebAPI.WebSocketsAPI.webSocket, ArrayBuffer.t) => unit

Parameters

WebAPI.WebSocketsAPI.webSocket ArrayBuffer.t

Return type

unit

send3

Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView. Read more on MDN

let send3: (
  WebAPI.WebSocketsAPI.webSocket,
  WebAPI.FileAPI.blob,
) => unit

Parameters

WebAPI.WebSocketsAPI.webSocket WebAPI.FileAPI.blob

Return type

unit

send4

Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView. Read more on MDN

let send4: (WebAPI.WebSocketsAPI.webSocket, string) => unit

Parameters

WebAPI.WebSocketsAPI.webSocket string

Return type

unit