SharedWorker

Types

t

type t = WebWorkersTypes.sharedWorker

workerOptions

type workerOptions = WebWorkersTypes.workerOptions = {
  mutable type_?: WebWorkersTypes.workerType,
  mutable credentials?: FetchTypes.requestCredentials,
  mutable name?: string,
}

Record fields

type_

option< WebWorkersTypes.workerType >

credentials

option< FetchTypes.requestCredentials >

name

option< string >

workerType

type workerType = WebWorkersTypes.workerType

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: (
  t,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.addEventListenerOptions=?,
) => unit

Parameters

t EventTypes.eventType EventTypes.eventListener option< EventTypes.addEventListenerOptions >

Return type

unit

addEventListenerWithCapture

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 addEventListenerWithCapture: (
  t,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

t EventTypes.eventType EventTypes.eventListener

Return type

unit

asEventTarget

let asEventTarget: t => EventTypes.eventTarget

Parameters

t

Return type

EventTypes.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: (t, EventTypes.event) => bool

Parameters

t EventTypes.event

Return type

bool

make

make(string)

The SharedWorker() constructor creates a SharedWorker object that executes the script at the specified URL. This script must obey the same-origin policy.

let shared: SharedWorker.t = SharedWorker.make("sharedworker.js")

Read more on MDN

let make: string => t

Parameters

string

Return type

t

makeWithName

makeWithName(string, string)

The SharedWorker() constructor creates a SharedWorker object that executes the script at the specified URL. This script must obey the same-origin policy.

let shared: SharedWorker.t = SharedWorker.makeWithName("sharedworker.js", "name")

Read more on MDN

let makeWithName: (string, string) => t

Parameters

string string

Return type

t

makeWithOptions

makeWithOptions(string, workerOptions)

The SharedWorker() constructor creates a SharedWorker object that executes the script at the specified URL. This script must obey the same-origin policy.

let shared: SharedWorker.t = SharedWorker.makeWithOptions("sharedworker.js", {
  name: "workerName",
  type_: Module,
})

Read more on MDN

let makeWithOptions: (string, workerOptions) => t

Parameters

string workerOptions

Return type

t

port

port(sharedWorker)

The port property of the SharedWorker interface returns a MessagePort object used to communicate and control the shared worker.

let port: MessagePort.t = SharedWorker.port(myWorker)

Read more on MDN

let port: t => MessagePort.t

Parameters

t

Return type

MessagePort.t

removeEventListener

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

let removeEventListener: (
  t,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.eventListenerOptions=?,
) => unit

Parameters

t EventTypes.eventType EventTypes.eventListener option< EventTypes.eventListenerOptions >

Return type

unit

removeEventListenerUseCapture

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

let removeEventListenerUseCapture: (
  t,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

t EventTypes.eventType EventTypes.eventListener

Return type

unit