Clients.claim()

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.

Expérimental: Cette fonction est expérimentale
Puisque cette fonction est toujours en développement dans certains navigateurs, veuillez consulter le tableau de compatibilité pour les préfixes à utiliser selon les navigateurs.
Il convient de noter qu'une fonctionnalité expérimentale peut voir sa syntaxe ou son comportement modifié dans le futur en fonction des évolutions de la spécification.

La méthode claim() de l'interface Clients permet à un service worker actif de se définir comme service worker actif de la page client quand le worker et la page sont dans le même scope. Ceci déclenche un évènement oncontrollerchange dans toutes les pages dans la portée du service worker.

Cette méthode peut être utilisée avec ServiceWorkerGlobalScope.skipWaiting() pour s'assurer que la mise à jour du service worker sous jacent prend effet immédiatement pour et le client courant et tous les autres clients actifs.

Syntaxe

js
ServiceWorkerClients.claim().then(function () {
  // Faire quelque chose
});

Paramètres

None.

Valeur de retour

Une Promise.

Exemple

L'exemple suivant utilise claim() dans le gestionnaire d'évènement onActivate d'un service worker. Donc la page client chargée dans la même portée n'a pas besoin d'être rechargée avant de pouvoir utiliser le service worker.

js
self.addEventListener("install", function (event) {
  event.waitUntil(self.skipWaiting());
});
self.addEventListener("activate", function (event) {
  event.waitUntil(self.clients.claim());
});

Spécifications

Specification
Service Workers
# clients-claim

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi