kotlin-browser/web.workers/DedicatedWorkerGlobalScope

DedicatedWorkerGlobalScope

open class DedicatedWorkerGlobalScope : WorkerGlobalScope, MessageEventTarget, JsCloseable(source)

The DedicatedWorkerGlobalScope object (the Worker global scope) is accessible through the self keyword. Some additional global functions, namespaces objects, and constructors, not typically associated with the worker global scope, but available on it, are listed in the JavaScript Reference. See also: Functions available to workers.

MDN Reference

Properties

fonts

open val fonts: FontFaceSet

MDN Reference

location

val location: WorkerLocation

The location read-only property of the WorkerGlobalScope interface returns the WorkerLocation associated with the worker. It is a specific location object, mostly a subset of the Location for browsing scopes, but adapted to workers.

name

val name: String

The name read-only property of the DedicatedWorkerGlobalScope interface returns the name that the Worker was (optionally) given when it was created. This is the name that the Worker() constructor can pass to get a reference to the DedicatedWorkerGlobalScope.

navigator

val navigator: WorkerNavigator

The navigator read-only property of the WorkerGlobalScope interface returns the WorkerNavigator associated with the worker. It is a specific navigator object, mostly a subset of the Navigator for browsing scopes, but adapted to workers.

onerror

var onerror: EventHandler<ErrorEvent, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

onlanguagechange

var onlanguagechange: EventHandler<Event, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

onmessage

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

onmessageerror

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

onoffline

var onoffline: EventHandler<Event, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

ononline

var ononline: EventHandler<Event, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

onrejectionhandled

var onrejectionhandled: EventHandler<PromiseRejectionEvent, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

onrtctransform

var onrtctransform: EventHandler<RTCTransformEvent, DedicatedWorkerGlobalScope, DedicatedWorkerGlobalScope>?

MDN Reference

onunhandledrejection

var onunhandledrejection: EventHandler<PromiseRejectionEvent, WorkerGlobalScope, WorkerGlobalScope>?

MDN Reference

Functions

open override fun close()

The close() method of the DedicatedWorkerGlobalScope interface discards any tasks queued in the DedicatedWorkerGlobalScope's event loop, effectively closing this particular scope.

dispatchEvent

open fun dispatchEvent(event: Event): Boolean

get

open operator fun get(key: String): JsAny?

open operator fun get(key: PropertyKey): JsAny?

postMessage

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

fun postMessage(message: String, options: StructuredSerializeOptions = definedExternally)

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

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

The postMessage() method of the DedicatedWorkerGlobalScope interface sends a message to the main thread that spawned it.

set

open operator fun set(key: String, value: JsAny?)

open operator fun set(key: PropertyKey, value: JsAny?)

when

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