ServiceWorkerContainer

{{APIRef("Service Workers API")}} {{SecureContext_Header}} {{AvailableInWorkers}}

The ServiceWorkerContainer interface of the Service Worker 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.

Most importantly, it exposes the {{domxref("ServiceWorkerContainer.register()")}} method used to register service workers, and the {{domxref("ServiceWorkerContainer.controller")}} property used to determine whether or not the current page is actively controlled.

ServiceWorkerContainer objects are exposed in the Window scope through {{domxref("Navigator.serviceWorker")}} and in workers using {{domxref("WorkerNavigator.serviceWorker")}} (if supported — check browser compatibility).

{{InheritanceDiagram}}

Instance properties

{{domxref("ServiceWorkerContainer.controller")}} {{ReadOnlyInline}}
- : Returns a {{domxref("ServiceWorker")}} object if its state is activating or activated (the same object returned by {{domxref("ServiceWorkerRegistration.active")}} ). This property returns null during a force-refresh request (Shift + refresh) or if there is no active worker.
{{domxref("ServiceWorkerContainer.ready")}} {{ReadOnlyInline}}
- : Provides a way of delaying code execution until a service worker is active. It returns a {{jsxref("Promise")}} that will never reject, and which waits indefinitely until the {{domxref("ServiceWorkerRegistration")}} associated with the current page has an {{domxref("ServiceWorkerRegistration.active")}} worker. Once that condition is met, it resolves with the {{domxref("ServiceWorkerRegistration")}} .

Instance methods

{{domxref("ServiceWorkerContainer.getRegistration()")}}
- : Gets a {{domxref("ServiceWorkerRegistration")}} object whose scope matches the provided document URL. The method returns a {{jsxref("Promise")}} that resolves to a {{domxref("ServiceWorkerRegistration")}} or undefined.
{{domxref("ServiceWorkerContainer.getRegistrations()")}}
- : Returns all {{domxref("ServiceWorkerRegistration")}} objects associated with a ServiceWorkerContainer in an array. The method returns a {{jsxref("Promise")}} that resolves to an array of {{domxref("ServiceWorkerRegistration")}} .
{{domxref("ServiceWorkerContainer.register()")}}
- : Creates or updates a {{domxref("ServiceWorkerRegistration")}} for the given scriptURL.
{{domxref("ServiceWorkerContainer.startMessages()")}}
- : Explicitly starts the flow of messages being dispatched from a service worker to pages under its control (e.g. sent via {{domxref("Client.postMessage()")}} ). This can be used to react to sent messages earlier, even before that page’s content has finished loading.

Events

{{domxref("ServiceWorkerContainer/controllerchange_event", "controllerchange")}}
- : Fired when the document’s associated {{domxref("ServiceWorkerRegistration")}} acquires a new {{domxref("ServiceWorkerRegistration.active","active")}} worker.
{{domxref("ServiceWorkerContainer/error_event", "error")}} {{Deprecated_Inline}} {{Non-standard_Inline}}
- : Fired whenever an error occurs in the associated service workers.
{{domxref("ServiceWorkerContainer/message_event", "message")}}
- : Fired when incoming messages are received by the ServiceWorkerContainer object (e.g. via a {{domxref("MessagePort.postMessage()")}} call).
{{domxref("ServiceWorkerContainer/messageerror_event", "messageerror")}}
- : Fired when incoming messages can not deserialized by the ServiceWorkerContainer object (e.g. via a {{domxref("MessagePort.postMessage()")}} call).

Examples

The example below first checks to see if the browser supports service workers. If supported, the code registers the service worker and determines if the page is actively controlled by the service worker. If it isn’t, it prompts the user to reload the page so the service worker can take control. The code also reports any registration failures.

if ("serviceWorker" in navigator) {
  // Register a service worker hosted at the root of the
  // site using the default scope.
  navigator.serviceWorker
    .register("/sw.js")
    .then((registration) => {
      console.log("Service worker registration succeeded:", registration);

      // At this point, you can optionally do something
      // with registration. See https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration
    })
    .catch((error) => {
      console.error(`Service worker registration failed: ${error}`);
    });

  // Independent of the registration, let's also display
  // information about whether the current page is controlled
  // by an existing service worker, and when that
  // controller changes.

  // First, do a one-off check if there's currently a
  // service worker in control.
  if (navigator.serviceWorker.controller) {
    console.log(
      "This page is currently controlled by:",
      navigator.serviceWorker.controller,
    );
  }

  // Then, register a handler to detect when a new or
  // updated service worker takes control.
  navigator.serviceWorker.oncontrollerchange = () => {
    console.log(
      "This page is now controlled by",
      navigator.serviceWorker.controller,
    );
  };
} else {
  console.log("Service workers are not supported.");
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

docs.rodeo

MDN Web Docs mirror