SharedWorker
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.WebWorkersAPI.sharedWorker, WebAPI.EventAPI.eventType, WebAPI.EventAPI.eventListener<'event>, ~options: WebAPI.EventAPI.addEventListenerOptions=?,) => unitParameters
WebAPI.WebWorkersAPI.sharedWorker WebAPI.EventAPI.eventType WebAPI.EventAPI.eventListener option< WebAPI.EventAPI.addEventListenerOptions >Return type
unitaddEventListenerWithCapture
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: ( WebAPI.WebWorkersAPI.sharedWorker, WebAPI.EventAPI.eventType, WebAPI.EventAPI.eventListener<'event>,) => unitParameters
WebAPI.WebWorkersAPI.sharedWorker WebAPI.EventAPI.eventType WebAPI.EventAPI.eventListenerReturn type
unitasEventTarget
let asEventTarget: WebAPI.WebWorkersAPI.sharedWorker => WebAPI.EventAPI.eventTargetdispatchEvent
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.WebWorkersAPI.sharedWorker, WebAPI.EventAPI.event,) => boolmake
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 = SharedWorker.make("sharedworker.js")
let make: string => WebAPI.WebWorkersAPI.sharedWorkermakeWithName
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 = SharedWorker.make("sharedworker.js", "name")
let makeWithName: (string, string) => WebAPI.WebWorkersAPI.sharedWorkermakeWithOptions
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 = SharedWorker.makeWithOptions("sharedworker.js", {
name: "workerName",
type_: Module
})
let makeWithOptions: ( string, WebAPI.WebWorkersAPI.workerOptions,) => WebAPI.WebWorkersAPI.sharedWorkerport
port(sharedWorker)
The port property of the SharedWorker interface returns a MessagePort object used to communicate and control the shared worker.
let port: WebAPI.ChannelMessagingAPI.messagePort = SharedWorker.port(myWorker)
let port: WebAPI.WebWorkersAPI.sharedWorker => WebAPI.ChannelMessagingAPI.messagePortremoveEventListener
Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN
let removeEventListener: ( WebAPI.WebWorkersAPI.sharedWorker, WebAPI.EventAPI.eventType, WebAPI.EventAPI.eventListener<'event>, ~options: WebAPI.EventAPI.eventListenerOptions=?,) => unitParameters
WebAPI.WebWorkersAPI.sharedWorker WebAPI.EventAPI.eventType WebAPI.EventAPI.eventListener option< WebAPI.EventAPI.eventListenerOptions >Return type
unitremoveEventListener_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.WebWorkersAPI.sharedWorker, WebAPI.EventAPI.eventType, WebAPI.EventAPI.eventListener<'event>,) => unit