Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Properties

Methods

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

  • addEventListener<K>(type: K, listener: ((this: internal.ServiceWorkerContainer, ev: ServiceWorkerContainerEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • 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

  • removeEventListener<K>(type: K, listener: ((this: internal.ServiceWorkerContainer, ev: ServiceWorkerContainerEventMap[K]) => any), options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

startMessages

  • startMessages(): void

  • Returns void

Generated using TypeDoc