Interface: Worker
The Worker interface of the Web Workers API represents a background task that can be created via script, which can send messages back to its creator.
Extends
EventTarget.AbstractWorker.MessageEventTarget<Worker>.Disposable
Properties
onerror
onerror: ((
this,ev) =>any) |null
Inherited from
AbstractWorker.onerror
onmessage
onmessage: ((
this,ev) =>any) |null
Inherited from
MessageEventTarget.onmessage
onmessageerror
onmessageerror: ((
this,ev) =>any) |null
Inherited from
MessageEventTarget.onmessageerror
Methods
[dispose]()
[dispose]():
void
Returns
void
addEventListener()
Call Signature
addEventListener<
K>(type,listener,options?):void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Type Parameters
K
K extends keyof WorkerEventMap
Parameters
type
K
listener
(this, ev) => any
options?
boolean | AddEventListenerOptions
Returns
void
Overrides
EventTarget.addEventListener
Call Signature
addEventListener(
type,listener,options?):void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Parameters
type
string
listener
EventListenerOrEventListenerObject
options?
boolean | AddEventListenerOptions
Returns
void
Overrides
EventTarget.addEventListener
dispatchEvent()
dispatchEvent(
event):boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
Parameters
event
Event
Returns
boolean
Inherited from
EventTarget.dispatchEvent
postMessage()
Call Signature
postMessage(
message,transfer):void
The postMessage() method of the Worker interface sends a message to the worker. The first parameter is the data to send to the worker. The data may be any JavaScript object that can be handled by the structured clone algorithm.
Parameters
message
any
transfer
Transferable[]
Returns
void
Call Signature
postMessage(
message,options?):void
Parameters
message
any
options?
StructuredSerializeOptions
Returns
void
removeEventListener()
Call Signature
removeEventListener<
K>(type,listener,options?):void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
Type Parameters
K
K extends keyof WorkerEventMap
Parameters
type
K
listener
(this, ev) => any
options?
boolean | EventListenerOptions
Returns
void
Overrides
EventTarget.removeEventListener
Call Signature
removeEventListener(
type,listener,options?):void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
Parameters
type
string
listener
EventListenerOrEventListenerObject
options?
boolean | EventListenerOptions
Returns
void
Overrides
EventTarget.removeEventListener
terminate()
terminate():
void
The terminate() method of the Worker interface immediately terminates the Worker. This does not offer the worker an opportunity to finish its operations; it is stopped at once.
Returns
void