Interface ServiceWorkerContainer

The ServiceWorkerContainer interface of the ServiceWorker API provides an object representing the service worker as an overall unit in the network ecosystem, including facilities to register, unregister and update service workers, and access the state of service workers and their registrations. Available only in secure contexts.

Hierarchy

  • EventTarget
    • ServiceWorkerContainer

Properties

controller oncontrollerchange onmessage onmessageerror ready

Methods

addEventListener dispatchEvent getRegistration getRegistrations register removeEventListener startMessages

Properties

Readonly controller

controller: null | <internal>.ServiceWorker

oncontrollerchange

oncontrollerchange: null | ((this: <internal>.ServiceWorkerContainer, ev: Event) => any)

onmessage

onmessage: null | ((this: <internal>.ServiceWorkerContainer, ev: <internal>.MessageEvent<any>) => any)

onmessageerror

onmessageerror: null | ((this: <internal>.ServiceWorkerContainer, ev: <internal>.MessageEvent<any>) => any)

Readonly ready

ready: Promise<<internal>.ServiceWorkerRegistration>

Methods

addEventListener

dispatchEvent

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

getRegistration

getRegistrations

register

removeEventListener

startMessages

  • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc