ServiceWorker

L'interface ServiceWorker de l'API ServiceWorker met à disposition une référence vers un service worker. Plusieurs  contextes de navigations (par exemple une page, un worker, etc.) peuvent être associés au même service worker, chacun à travers un unique objet ServiceWorker.

Un objet ServiceWorker est disponible dans les propriétés  ServiceWorkerRegistration.active et ServiceWorkerContainer.controller — c'est un service worker qui a été activé et qui contrôle la page (ce service worker a été bien enregistré, et la page contrôlée a été rechargée).

L'interface ServiceWorker est distribuée à travers différents évènements de son cycle de vie — install et activate — et d'utilisation, comme fetch. Un objet ServiceWorker a un état associé ServiceWorker.state, lié à son cycle de vie.

Propriétés

L'interface ServiceWorker hérite des propriétés de son parent, le Worker.

ServiceWorker.scriptURL Lecture seule
Retourne la scriptURL sérialisée du ServiceWorker, définie comme une partie du ServiceWorkerRegistration. Cette URL doit avoir la même origine que le document qui enregistre le  ServiceWorker.
ServiceWorker.state Lecture seule
Retourne le status du service worker. Il retourne l'une des valeurs suivantes : installing, installed, activating, activated, or redundant.

Gestionnaires d'évènements

ServiceWorker.onstatechange Lecture seule
Une propriété EventListener est appelée quand un évènement de type statechange est déclenché; c'est le cas dès que le ServiceWorker.state change.

Méthodes

L'interface du ServiceWorker hérite des méthodes de son parent, Worker, avec l'exception de Worker.terminate, qui ne doit pas être accessible depuis le service worker.

Exemples

Ce fragment de code provient d'un exemple d'enregistrement d'évènement pour le service worker (démo en direct). Le code écoute tout changement du ServiceWorker.state et retourne sa valeur.

if ('serviceWorker' in navigator) {
  navigator.serviceWorker
    .register('service-worker.js', {
      scope: './'
    })
    .then(({ installing, waiting, active }) => {
      let serviceWorker
      if (installing) {
        serviceWorker = installing
        document.querySelector('#kind').textContent = 'installé'
      } else if (waiting) {
        serviceWorker = waiting
        document.querySelector('#kind').textContent = 'en attente'
      } else if (active) {
        serviceWorker = active
        document.querySelector('#kind').textContent = 'actif'
      }
      if (serviceWorker) {
        // logState(serviceWorker.state);
        serviceWorker.addEventListener('statechange', (e) => {
          // logState(e.target.state);
        })
      }
    })
    .catch((error) => {
      // L'enregistrement s'est mal déroulé. Le fichier service-worker.js
      // est peut-être indisponible ou contient une erreur.
    })
} else {
  // Le navigateur ne supporte pas les service workers.
}

Spécifications

Spécification État Commentaire
Service Workers
La définition de 'ServiceWorker' dans cette spécification.
Version de travail Définition initiale.

Compatibilité des navigateurs

Update compatibility data on GitHub
OrdinateurMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariWebview AndroidChrome pour AndroidFirefox pour AndroidOpera pour AndroidSafari sur iOSSamsung Internet
ServiceWorker
Expérimentale
Chrome Support complet 40Edge Support complet 17
Support complet 17
Support complet 16
Désactivée
Désactivée From version 16: this feature is behind the Enable service workers preference.
Firefox Support complet 44
Notes
Support complet 44
Notes
Notes Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
IE Aucun support NonOpera Support complet 27Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 27Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
onstatechange
Expérimentale
Chrome Support complet 40Edge Support complet 17
Support complet 17
Support complet 16
Désactivée
Désactivée From version 16: this feature is behind the Enable service workers preference.
Firefox Support complet 44
Notes
Support complet 44
Notes
Notes Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
IE Aucun support NonOpera Support complet 27Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 27Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
scriptURL
Expérimentale
Chrome Support complet 40Edge Support complet 17
Support complet 17
Support complet 16
Désactivée
Désactivée From version 16: this feature is behind the Enable service workers preference.
Firefox Support complet 44
Notes
Support complet 44
Notes
Notes Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
IE Aucun support NonOpera Support complet 27Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 27Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
state
Expérimentale
Chrome Support complet 40Edge Support complet 17
Support complet 17
Support complet 16
Désactivée
Désactivée From version 16: this feature is behind the Enable service workers preference.
Firefox Support complet 44
Notes
Support complet 44
Notes
Notes Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
IE Aucun support NonOpera Support complet 27Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 27Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0

Légende

Support complet  
Support complet
Aucun support  
Aucun support
Fonctionnalité expérimentale. Celle-ci peut être amenée à changer par la suite.
Fonctionnalité expérimentale. Celle-ci peut être amenée à changer par la suite.
Voir les notes d'implémentation.
Voir les notes d'implémentation.
Une action explicite de l'utilisateur est nécessaire pour activer cette fonctionnalité.
Une action explicite de l'utilisateur est nécessaire pour activer cette fonctionnalité.

Voir aussi