ServiceWorkerContainer

ServiceWorkerContainer.controller Nur lesbar

Gibt ein ServiceWorker-Objekt zurück, wenn dessen Zustand activating oder activated ist (dasselbe Objekt, das von ServiceWorkerRegistration.active zurückgegeben wird). Diese Eigenschaft gibt null während einer Zwangsaktualisierungsanfrage (Shift + Aktualisierung) oder wenn kein aktiver Worker vorhanden ist, zurück.

ServiceWorkerContainer.ready Nur lesbar

Bietet eine Möglichkeit, die Ausführung von Code zu verzögern, bis ein Service Worker aktiv ist. Es gibt ein Promise zurück, das niemals ablehnt und unbegrenzt wartet, bis der der aktuellen Seite zugeordnete ServiceWorkerRegistration einen ServiceWorkerRegistration.active Worker hat. Sobald diese Bedingung erfüllt ist, wird es mit dem ServiceWorkerRegistration aufgelöst.

ServiceWorkerContainer.getRegistration()

Holt ein ServiceWorkerRegistration-Objekt, dessen Gültigkeitsbereich zur angegebenen Dokument-URL passt. Die Methode gibt ein Promise zurück, das auf ein ServiceWorkerRegistration oder undefined aufgelöst wird.

ServiceWorkerContainer.getRegistrations()

Gibt alle ServiceWorkerRegistration-Objekte zurück, die einem ServiceWorkerContainer in einem Array zugeordnet sind. Die Methode gibt ein Promise zurück, das zu einem Array von ServiceWorkerRegistration aufgelöst wird.

ServiceWorkerContainer.register()

Erstellt oder aktualisiert eine ServiceWorkerRegistration für die angegebene scriptURL.

ServiceWorkerContainer.startMessages()

startet ausdrücklich den Fluss von Nachrichten, die von einem Service Worker an Seiten unter seiner Kontrolle gesendet werden (z.B. gesendet über Client.postMessage()). Dies kann verwendet werden, um auf gesendete Nachrichten früher zu reagieren, noch bevor der Inhalt der Seite vollständig geladen ist.

controllerchange

Tritt auf, wenn die dem Dokument zugeordnete ServiceWorkerRegistration einen neuen active Worker erhält.

error Veraltet Nicht standardisiert

Wird immer dann ausgelöst, wenn ein Fehler in den zugehörigen Service Workern auftritt.

message

Tritt auf, wenn eingehende Nachrichten vom ServiceWorkerContainer-Objekt empfangen werden (z.B. über einen MessagePort.postMessage()-Aufruf).

messageerror

Tritt auf, wenn eingehende Nachrichten nicht vom ServiceWorkerContainer-Objekt deserialisiert werden können (z.B. über einen MessagePort.postMessage()-Aufruf).

Das folgende Beispiel prüft zunächst, ob der Browser Service Worker unterstützt. Wenn ja, registriert der Code den Service Worker und stellt fest, ob die Seite aktiv vom Service Worker gesteuert wird. Wenn nicht, wird der Benutzer aufgefordert, die Seite neu zu laden, damit der Service Worker die Kontrolle übernehmen kann. Der Code meldet auch alle Registrierungsfehler.

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.");
}

• Verwendung von Service Workern
• Grundlegendes Code-Beispiel für Service Worker
• Verwendung von Web Workern