kotlin-browser/web.workers/Worker

Worker

open external class Worker(scriptURL: String, options: WorkerOptions = definedExternally) : EventTarget, AbstractWorker, MessageEventTarget(source)

This Web Workers API interface 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.

MDN Reference

Constructors

Worker

constructor(scriptURL: URL, options: WorkerOptions = definedExternally)

constructor(scriptURL: String, options: WorkerOptions = definedExternally)

Properties

errorEvent

val errorEvent: EventInstance<Event, Worker, Worker>

MDN Reference

messageErrorEvent

val messageErrorEvent: EventInstance<MessageEvent<Any?>, Worker, Worker>

MDN Reference

messageEvent

val messageEvent: EventInstance<MessageEvent<Any?>, Worker, Worker>

MDN Reference

onerror

open var onerror: EventHandler<ErrorEvent, AbstractWorker, AbstractWorker>?

MDN Reference

onmessage

open var onmessage: EventHandler<Event, MessageEventTarget, MessageEventTarget>?

onmessageerror

open var onmessageerror: EventHandler<Event, MessageEventTarget, MessageEventTarget>?

Functions

dispatchEvent

fun dispatchEvent(event: Event): Boolean

postMessage

fun postMessage(message: Any?, transfer: ReadonlyArray<Transferable>)

Clones message and transmits it to worker's global environment. transfer can be passed as a list of objects that are to be transferred rather than cloned.

fun postMessage(message: Any?, options: StructuredSerializeOptions = definedExternally)

terminate

fun terminate()

Aborts worker's associated global environment.