web.workers.Worker — clojure-interop/cljs-web-api 1.0.4

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

constructor cljs

Constructor.

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

aURL \tA web.USVString representing the URL of the script the worker will execute. It must obey the same-origin policy. \toptions Optional \tAn object containing option properties that can be set when creating the object instance. Available properties are as follows:

\t\ttype: A web.dom.DOMString specifying the type of worker to create. The value can be classic or module. If not specified, the default used is classic. \t\tcredentials: A web.dom.DOMString specifying the type of credentials to use for the worker. The value can be omit, same-origin, or include. If not specified, or if type is classic, the default used is omit (no credentials required). \t\tname: A web.dom.DOMString specifying an identifying name for the web.workers.DedicatedWorkerGlobalScope representing the scope of the worker, which is mainly useful for debugging purposes.

See also: https://developer.mozilla.org/en-US/docs/Web/API/Worker/Worker

onerror cljs

(onerror this)

Property.

The AbstractWorker.onerror property of the web.workers.AbstractWorker represents an EventHandler, that is a function to be called the error event occurs and bubbles through the web.workers.Worker.

myWorker.onerror = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/AbstractWorker/onerror

onmessage cljs

(onmessage this)

Property.

The onmessage property of the web.workers.Worker interface an EventHandler, that is a function to be called when the message occurs. These events are of type web.workers.MessageEvent and be called when the worker's parent receives a message (i.e. from DedicatedWorkerGlobalScope.postMessage method).

myWorker.onmessage = function(e) { ... }

See also: https://developer.mozilla.org/en-US/docs/Web/API/Worker/onmessage

onmessageerror cljs

(onmessageerror this)

Property.

The onmessageerror event handler of the web.workers.Worker is an web.EventListener, called whenever an web.workers.MessageEvent type messageerror is fired on the Worker instance — that is, it receives a message that cannot be deserialized.

Worker.onmessageerror = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/Worker/onmessageerror

post-message cljs

(post-message this & args)

Method.

The postMessage() method of the web.workers.Worker interface a message to the worker's inner scope. This accepts a single which is the data to send to the worker. The data may be any or JavaScript object handled by the structured clone algorithm, includes cyclical references.

worker.postMessage(message, [transfer]);

See also: https://developer.mozilla.org/en-US/docs/Web/API/Worker/postMessage

set-onerror! cljs

(set-onerror! this val)

Property.

The AbstractWorker.onerror property of the web.workers.AbstractWorker represents an EventHandler, that is a function to be called the error event occurs and bubbles through the web.workers.Worker.

myWorker.onerror = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/AbstractWorker/onerror

set-onmessage! cljs

(set-onmessage! this val)

Property.

The onmessage property of the web.workers.Worker interface an EventHandler, that is a function to be called when the message occurs. These events are of type web.workers.MessageEvent and be called when the worker's parent receives a message (i.e. from DedicatedWorkerGlobalScope.postMessage method).

myWorker.onmessage = function(e) { ... }

See also: https://developer.mozilla.org/en-US/docs/Web/API/Worker/onmessage

set-onmessageerror! cljs

(set-onmessageerror! this val)

Property.

The onmessageerror event handler of the web.workers.Worker is an web.EventListener, called whenever an web.workers.MessageEvent type messageerror is fired on the Worker instance — that is, it receives a message that cannot be deserialized.

Worker.onmessageerror = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/Worker/onmessageerror

terminate cljs

(terminate this)

Method.

The terminate() method of the web.workers.Worker interface terminates the web.workers.Worker. This does not offer the an opportunity to finish its operations; it is simply stopped once.

myWorker.terminate();

See also: https://developer.mozilla.org/en-US/docs/Web/API/Worker/terminate