ServiceWorkerContainer

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2018.

Экспериментальная возможность: Это экспериментальная технология
Так как спецификация этой технологии ещё не стабилизировалась, смотрите таблицу совместимости по поводу использования в различных браузерах. Также заметьте, что синтаксис и поведение экспериментальной технологии может измениться в будущих версиях браузеров, вслед за изменениями спецификации.

ServiceWorker API предоставляет интерфейс ServiceWorkerContainer, являющийся объектом (объект представляет собой сервис воркер, как единое целое в сетевой экосистеме) включающим следующие средства: Регистрация; Отмена регистрации; Обновление сервис воркеров; Доступ к состоянию сервис воркеров; Доступ к регистрации сервис воркеров.

Most importantly, it exposes the ServiceWorkerContainer.register(scriptURL, scope[, base]) method used to register service workers, and the ServiceWorkerContainer.controller property used to determine whether or not the current page is actively controlled.

Properties

ServiceWorkerContainer.controller Только для чтения

Returns a ServiceWorker object if its state is activated (the same object returned by ServiceWorkerRegistration.active). This property returns null if the request is a force refresh (Shift + refresh) or if there is no active worker.

ServiceWorkerContainer.ready Только для чтения

Defines whether a service worker is ready to control a page or not. It returns a Promise that will never reject, which resolves to a ServiceWorkerRegistration with an ServiceWorkerRegistration.active worker.

Event handlers

ServiceWorkerContainer.oncontrollerchange

An event handler fired whenever a controllerchange event occurs — when the document's associated ServiceWorkerRegistration acquires a new ServiceWorkerRegistration.active worker.

ServiceWorkerContainer.onerror

An event handler fired whenever an error event occurs in the associated service workers.

ServiceWorkerContainer.onmessage

An event handler fired whenever a message event occurs — when incoming messages are received to the ServiceWorkerContainer object (e.g. via a MessagePort.postMessage() call.)

Methods

ServiceWorkerContainer.register()

Creates or updates a ServiceWorkerRegistration for the given scriptURL.

ServiceWorkerContainer.getRegistration()

Gets a ServiceWorkerRegistration object whose scope URL matches the provided document URL. If the method can't return a ServiceWorkerRegistration, it returns a Promise.

ServiceWorkerContainer.getRegistrations()

Returns all ServiceWorkerRegistrations associated with a ServiceWorkerContainer in an array. If the method can't return ServiceWorkerRegistrations, it returns a Promise.

Examples

This code snippet is from the service worker fallback-response sample (see fallback-response live). The code checks to see if the browser supports service workers. Then 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.

js
if ("serviceWorker" in navigator) {
  navigator.serviceWorker
    .register("service-worker.js", { scope: "./" })
    .then(function () {
      if (navigator.serviceWorker.controller) {
        document.querySelector("#status").textContent =
          "The service worker is currently handling network operations.";
        showRequestButtons();
      } else {
        document.querySelector("#status").textContent =
          "Please reload this page to allow the service worker to handle network operations.";
      }
    })
    .catch(function (error) {
      document.querySelector("#status").textContent = error;
    });
} else {
  var aElement = document.createElement("a");
  aElement.href =
    "http://www.chromium.org/blink/serviceworker/service-worker-faq";
  aElement.textContent = "unavailable";
  document.querySelector("#status").appendChild(aElement);
}

Спецификации

Specification
Service Workers
# serviceworkercontainer-interface

Совместимость с браузерами

BCD tables only load in the browser

Смотрите также