kotlin-browser/web.serviceworker/ServiceWorker

ServiceWorker

open class ServiceWorker : EventTarget, AbstractWorker, MessageEventSource(source)

The ServiceWorker interface of the Service Worker API provides a reference to a service worker. Multiple browsing contexts (e.g., pages, workers, etc.) can be associated with the same service worker, each through a unique ServiceWorker object. Available only in secure contexts.

MDN Reference

Properties

onerror

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

MDN Reference

onstatechange

var onstatechange: EventHandler<Event, ServiceWorker, ServiceWorker>?

MDN Reference

scriptURL

val scriptURL: String

Returns the ServiceWorker serialized script URL defined as part of ServiceWorkerRegistration. Must be on the same origin as the document that registers the ServiceWorker.

state

val state: ServiceWorkerState

The state read-only property of the ServiceWorker interface returns a string representing the current state of the service worker. It can be one of the following values: parsed, installing, installed, activating, activated, or redundant.

Functions

dispatchEvent

open fun dispatchEvent(event: Event): Boolean

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 ServiceWorker 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 which can be handled by the structured clone algorithm.

when

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