kotlin-browser/web.workers/Worker

Worker

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

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.

MDN Reference

Constructors

Worker

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

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

Properties

onerror

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

MDN Reference

onmessage

open var onmessage: EventHandler<MessageEvent<*>, MessageEventTarget, MessageEventTarget>?

onmessageerror

open var onmessageerror: EventHandler<MessageEvent<*>, MessageEventTarget, MessageEventTarget>?

Functions

dispatchEvent

fun dispatchEvent(event: Event): Boolean

postMessage

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

The postMessage() method of the Worker interface sends a message to the worker.

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

terminate

fun terminate()

The terminate() method of the Worker interface immediately terminates the Worker.

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>