ServiceWorkerContainer

Propiedades de instancia

ServiceWorkerContainer.controller Read only

Un objeto ServiceWorker que representa al service worker activo que controla la página actual, o null si la página no tiene un service worker activo o en proceso de activación.

ServiceWorkerContainer.ready Read only

Devuelve un Promise que se resuelve con el ServiceWorkerRegistration asociado a la página actual, pero solo cuando hay un service worker activo. Esto proporciona un mecanismo para diferir la ejecución del código hasta que un service worker esté activo.

Métodos de instancia

ServiceWorkerContainer.getRegistration()

Obtiene un objeto ServiceWorkerRegistration cuyo alcance coincide con la URL del documento proporcionado. El método devuelve un Promise que se resuelve en un ServiceWorkerRegistration o undefined.

ServiceWorkerContainer.getRegistrations()

Devuelve todos los objetos ServiceWorkerRegistration asociados con un ServiceWorkerContainer en un arreglo. El método devuelve un Promise que se resuelve en un arreglo de ServiceWorkerRegistration.

ServiceWorkerContainer.register()

Crea o actualiza un ServiceWorkerRegistration para el scriptURL dado.

ServiceWorkerContainer.startMessages()

Inicia explícitamente el flujo de mensajes que se envían desde un service worker a las páginas bajo su control (por ejemplo, enviados a través de Client.postMessage()). Esto se puede usar para reaccionar antes a los mensajes enviados, incluso antes de que el contenido de esa página haya terminado de cargarse.

Eventos

controllerchange

Se dispara cuando el ServiceWorkerRegistration asociado al documento adquiere un nuevo worker active.

message

Se dispara cuando el objeto ServiceWorkerContainer recibe mensajes entrantes (por ejemplo, a través de una llamada a MessagePort.postMessage()).

messageerror

Se dispara cuando el objeto ServiceWorkerContainer no puede deserializar los mensajes entrantes (por ejemplo, a través de una llamada a MessagePort.postMessage()).

Ejemplos

El siguiente ejemplo primero verifica si el navegador es compatible con service workers. Si es compatible, el código registra el service worker y determina si la página está siendo controlada activamente por el service worker. Si no es así, solicita al usuario que vuelva a cargar la página para que el service worker pueda tomar el control. El código también informa de cualquier error de registro.

if ("serviceWorker" in navigator) {
  // Registrar un service worker alojado en la raíz del
  // sitio utilizando el alcance predeterminado.
  navigator.serviceWorker
    .register("/sw.js")
    .then((registration) => {
      console.log(
        "El registro del service worker se realizó correctamente:",
        registration,
      );

      // En este punto, opcionalmente se puede hacer algo
      // con el registro. Ver https://mdn.go-mizu.dev/es/docs/Web/API/ServiceWorkerRegistration
    })
    .catch((error) => {
      console.error(`El registro del service worker falló: ${error}`);
    });

  // Independientemente del registro, también mostremos
  // información sobre si la página actual está controlada
  // por un service worker existente y cuándo cambia ese
  // controlador.

  // Primero, hacer una verificación única para saber si
  // actualmente hay un service worker en control.
  if (navigator.serviceWorker.controller) {
    console.log(
      "Esta página está actualmente controlada por:",
      navigator.serviceWorker.controller,
    );
  }

  // Luego, registrar un manejador para detectar cuándo
  // un service worker nuevo o actualizado toma el control.
  navigator.serviceWorker.oncontrollerchange = () => {
    console.log(
      "Esta página ahora está controlada por",
      navigator.serviceWorker.controller,
    );
  };
} else {
  console.log("Los service workers no son compatibles.");
}

Especificaciones

Compatibilidad con navegadores

Véase también

• Uso de Service Workers
• Ejemplo de código básico de service worker
• Uso de web workers