Class Worker

Namespace

CSharpToJavaScript.APIs.JS

Assembly

CSharpToJavaScript.dll

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.

[Value("Worker")]
public class Worker : EventTarget, AbstractWorker, MessageEventTarget

Inheritance

object

EventTarget

Worker

Implements

AbstractWorker

MessageEventTarget

Inherited Members

EventTarget.AddEventListener(string, Action, Union26)

EventTarget.AddEventListener(string, Action<MouseEvent>, Union26)

EventTarget.AddEventListener(string, Action<Event>, Union26)

EventTarget.RemoveEventListener(string, Action, Union27)

EventTarget.AddEventListener(string, EventListener, Union26)

EventTarget.RemoveEventListener(string, EventListener, Union27)

EventTarget.DispatchEvent(Event)

EventTarget.When(string, ObservableEventListenerOptions)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Creating a worker is done by calling the Worker("path/to/worker/script") constructor.

Workers may themselves spawn new workers, as long as those workers are hosted at the same origin as the parent page.

Note that not all interfaces and functions are available to web workers. See Functions and classes available to Web Workers for details.

-Using Web Workers
-Functions and classes available to Web Workers
-Other kind of workers: SharedWorker and Service Worker.
-OffscreenCanvas interface

See also on MDN

Constructors

Worker()

public Worker()

Worker(Union96, WorkerOptions)

WARNING

This script passed to the url element is executed.
APIs like this are known as injection sinks, and are potentially a vector for cross-site scripting (XSS) attacks.

public Worker(Union96 scriptURL, WorkerOptions options = null)

Parameters

scriptURL Union96

options WorkerOptions

Remarks

You can mitigate this risk by having a Content Security Policy (CSP) that restricts the locations from which scripts can be loaded, and by always assigning TrustedScriptURL objects instead of strings and enforcing trusted types.
See Security considerations for more information.

The Worker() constructor creates a Worker object that executes the classic script or module at the specified URL.

-Worker
-Trusted Types API

See also on MDN

Methods

PostMessage(dynamic, StructuredSerializeOptions)

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.

[Value("postMessage")]
public GlobalObject.Undefined PostMessage(dynamic message, StructuredSerializeOptions options = null)

Parameters

message dynamic

options StructuredSerializeOptions

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

The Worker postMessage() method delegates to the MessagePort PostMessage(dynamic, List<Object>) method, which adds a task on the event loop corresponding to the receiving MessagePort.

The Worker can send back information to the thread that spawned it using the PostMessage(dynamic, List<Object>) method.

-The Worker interface it belongs to.

See also on MDN

PostMessage(dynamic, List<Object>)

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.

[Value("postMessage")]
public GlobalObject.Undefined PostMessage(dynamic message, List<Object> transfer)

Parameters

message dynamic

transfer List<Object>

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

The Worker postMessage() method delegates to the MessagePort PostMessage(dynamic, List<Object>) method, which adds a task on the event loop corresponding to the receiving MessagePort.

The Worker can send back information to the thread that spawned it using the PostMessage(dynamic, List<Object>) method.

-The Worker interface it belongs to.

See also on MDN

Terminate()

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.

[Value("terminate")]
public GlobalObject.Undefined Terminate()

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

-Worker interface
-Close()
-Close()

See also on MDN