View source

class Worker

package js.html

extends EventTarget

@:native("Worker")

Available on js

The Worker interface of the Web Workers API represents a background task that can be easily created and can send messages back to its creator. Creating a worker is as simple as calling the Worker() constructor and specifying a script to be run in the worker thread.

Documentation Worker by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:

Constructor

new(scriptURL:String, ?options:Null<WorkerOptions>)

Throws:

null

DOMError

Variables

onerror:Function

onmessage:Function

An EventListener called whenever a MessageEvent of type message bubbles through the worker — i.e. when a message is sent to the parent document from the worker via DedicatedWorkerGlobalScope.postMessage. The message is stored in the event's MessageEvent.data property.

onmessageerror:Function

Is an EventHandler representing the code to be called when the messageerror event is raised.

Methods

postMessage(message:Dynamic, ?transfer:Array<Dynamic>):Void

Sends a message — which can consist of any JavaScript object — to the worker's inner scope.

Throws:

null

DOMError

terminate():Void

Immediately terminates the worker. This does not offer the worker an opportunity to finish its operations; it is simply stopped at once. ServiceWorker instances do not support this method.

Inherited Variables

Inherited Methods

Defined by EventTarget

addEventListener(type:String, listener:Function, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void

addEventListener(type:String, listener:EventListener, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void

Register an event handler of a specific event type on the EventTarget.

Throws:

null

DOMError

dispatchEvent(event:Event):Bool

Dispatch an event to this EventTarget.

Throws:

null

DOMError

removeEventListener(type:String, listener:Function, ?options:EitherType<EventListenerOptions, Bool>):Void

removeEventListener(type:String, listener:EventListener, ?options:EitherType<EventListenerOptions, Bool>):Void

Removes an event listener from the EventTarget.

Throws:

null

DOMError