ServiceWorker extension type

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

A ServiceWorker object is available via a number of properties:

• ServiceWorkerRegistration.active
• ServiceWorkerGlobalScope.serviceWorker
• ServiceWorkerContainer.controller — when the service worker is in activating or activated state
• ServiceWorkerRegistration.installing — when the service worker is in installing state
• ServiceWorkerRegistration.waiting — when the service worker is in installed state

The ServiceWorker interface is dispatched a set of lifecycle events — install and activate — and functional events including fetch. A ServiceWorker object has an associated ServiceWorker.state, related to its lifecycle.

Service workers allow static import of ECMAScript modules, if supported, using import. Dynamic import is disallowed by the specification — calling import() will throw.

on

• JSObject

Implemented types

• EventTarget
• JSObject

Properties

hashCode → int

The hash code for this object.

no setter, inherited

onerror ↔ EventHandler?

getter/setter pair

onstatechange ↔ EventHandler?

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scriptURL → String

no setter

state → ServiceWorkerState

no setter

Methods

addEventListener(String type, EventListener? callback, [JSAny options]) → void

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

inherited

dispatchEvent(Event event) → bool

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

postMessage(JSAny? message, [JSObject optionsOrTransfer]) → void

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.

removeEventListener(String type, EventListener? callback, [JSAny options]) → void

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited