ServiceWorkerGlobalScope

Cette traduction est incomplète. Aidez-nous à traduire cet article depuis l’anglais

The ServiceWorkerGlobalScope interface of the Service Worker API represents the global execution context of a service worker.

Developers should keep in mind that the ServiceWorker state is not persisted across the termination/restart cycle, so each event handler should assume it's being invoked with a bare, default global state.

Once successfully registered, a service worker can and will be terminated when idle to conserve memory and processor power. An active service worker is automatically restarted to respond to events, such as ServiceWorkerGlobalScope.onfetch or ServiceWorkerGlobalScope.onmessage.

Additionally, synchronous requests are not allowed from within a service worker — only asynchronous requests, like those initiated via the fetch() method, can be used.

This interface inherits from the WorkerGlobalScope interface, and its parent EventTarget, and therefore implements properties from WindowTimers, WindowBase64, and WindowEventHandlers.

Properties

ServiceWorkerGlobalScope.caches Lecture seule
Contains the CacheStorage object associated with the service worker.
ServiceWorkerGlobalScope.clients Lecture seule
Contains the Clients object associated with the service worker.
ServiceWorkerGlobalScope.registration Lecture seule
Contains the ServiceWorkerRegistration object that represents the service worker's registration.

Events

activate
Occurs when a ServiceWorkerRegistration acquires a new ServiceWorkerRegistration.active worker.
Also available via the ServiceWorkerGlobalScope.onactivate property.
contentdelete
Occurs when an item is removed from the Content Index.
Also available via the ServiceWorkerGlobalScope.oncontentdelete property.
fetch
Occurs when a fetch() is called.
Also available via the ServiceWorkerGlobalScope.onfetch property.
install
Occurs when a ServiceWorkerRegistration acquires a new ServiceWorkerRegistration.installing worker.
Also available via the ServiceWorkerGlobalScope.oninstall property.
message
Occurs when incoming messages are received. Controlled pages can use the MessagePort.postMessage() method to send messages to service workers. The service worker can optionally send a response back via the MessagePort exposed in event.data.port, corresponding to the controlled page.
Also available via the ServiceWorkerGlobalScope.onmessage property.
notificationclick
Occurs when a user clicks on a displayed notification.
Also available via the ServiceWorkerGlobalScope.onnotificationclick property.
notificationclose
Occurs — when a user closes a displayed notification.
Also available via the ServiceWorkerGlobalScope.onnotificationclose property.
push
Occurs when a server push notification is received.
Also available via the ServiceWorkerGlobalScope.onpush property.
pushsubscriptionchange
Occurs when a push subscription has been invalidated, or is about to be invalidated (e.g. when a push service sets an expiration time).
Also available via the ServiceWorkerGlobalScope.onpushsubscriptionchange property.
sync
Triggered when a call to SyncManager.register is made from a service worker client page. The attempt to sync is made either immediately if the network is available or as soon as the network becomes available.
Also available via the ServiceWorkerGlobalScope.onsync property.

Methods

ServiceWorkerGlobalScope.skipWaiting()
Allows the current service worker registration to progress from waiting to active state while service worker clients are using it.

ServiceWorkerGlobalScope implements WorkerGlobalScope — which implements WindowOrWorkerGlobalScope. Therefore it also has the following property available to it:

GlobalFetch.fetch()
Starts the process of fetching a resource. This returns a promise that resolves to the Response object representing the response to your request. This algorithm is the entry point for the fetch handling handed to the service worker context.

Examples

This code snippet is from the service worker prefetch sample (see prefetch example live.) The ServiceWorkerGlobalScope.onfetch event handler listens for the fetch event. When fired, the code returns a promise that resolves to the first matching request in the Cache object. If no match is found, the code fetches a response from the network.

The code also handles exceptions thrown from the fetch() operation. Note that an HTTP error response (e.g., 404) will not trigger an exception. It will return a normal response object that has the appropriate error code set.

self.addEventListener('fetch', function(event) {
  console.log('Handling fetch event for', event.request.url);

  event.respondWith(
    caches.match(event.request).then(function(response) {
      if (response) {
        console.log('Found response in cache:', response);

        return response;
      }
      console.log('No response found in cache. About to fetch from network...');

      return fetch(event.request).then(function(response) {
        console.log('Response from network is:', response);

        return response;
      }, function(error) {
        console.error('Fetching failed:', error);

        throw error;
      });
    })
  );
});

Specifications

Specification Status Comment
Service Workers
La définition de 'ServiceWorkerGlobalScope' dans cette spécification.
Version de travail Initial definition

Browser compatibility

Update compatibility data on GitHub
OrdinateurMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariWebview AndroidChrome pour AndroidFirefox pour AndroidOpera pour AndroidSafari sur iOSSamsung Internet
ServiceWorkerGlobalScopeChrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
activate event
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
caches
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
clients
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
install event
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
message event
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
notificationclick eventChrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Aucun support NonChrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 27Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
onabortpayment
Expérimentale
Chrome Support complet 61
Désactivée
Support complet 61
Désactivée
Désactivée From version 61: this feature is behind the #service-worker-payment-apps preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.
Edge Support complet ≤79
Désactivée
Support complet ≤79
Désactivée
Désactivée From version ≤79: this feature is behind the #service-worker-payment-apps preference (needs to be set to Enabled).
Firefox ? IE Aucun support NonOpera ? Safari Support complet 11.1WebView Android Aucun support NonChrome Android Support complet 61
Désactivée
Support complet 61
Désactivée
Désactivée From version 61: this feature is behind the #service-worker-payment-apps preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.
Firefox Android ? Opera Android ? Safari iOS Support complet 11.3Samsung Internet Android Aucun support Non
onactivate
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
onbackgroundfetchabort
Expérimentale
Chrome Support complet 74Edge Aucun support NonFirefox Aucun support NonIE Aucun support NonOpera Support complet 62Safari Aucun support NonWebView Android Aucun support NonChrome Android Support complet 74Firefox Android Aucun support NonOpera Android Support complet 53Safari iOS Aucun support NonSamsung Internet Android Support complet 11.0
onbackgroundfetchclick
Expérimentale
Chrome Support complet 74Edge Aucun support NonFirefox Aucun support NonIE Aucun support NonOpera Support complet 62Safari Aucun support NonWebView Android Aucun support NonChrome Android Support complet 74Firefox Android Aucun support NonOpera Android Support complet 53Safari iOS Aucun support NonSamsung Internet Android Support complet 11.0
onbackgroundfetchfail
Expérimentale
Chrome Support complet 74Edge Aucun support NonFirefox Aucun support NonIE Aucun support NonOpera Support complet 62Safari Aucun support NonWebView Android Aucun support NonChrome Android Support complet 74Firefox Android Aucun support NonOpera Android Support complet 53Safari iOS Aucun support NonSamsung Internet Android Support complet 11.0
onbackgroundfetchsuccess
Expérimentale
Chrome Support complet 74Edge Aucun support NonFirefox Aucun support NonIE Aucun support NonOpera Support complet 62Safari Aucun support NonWebView Android Aucun support NonChrome Android Support complet 74Firefox Android Aucun support NonOpera Android Support complet 53Safari iOS Aucun support NonSamsung Internet Android Support complet 11.0
oncanmakepayment
Expérimentale
Chrome Support complet 61
Désactivée
Support complet 61
Désactivée
Désactivée From version 61: this feature is behind the #service-worker-payment-apps preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.
Edge Support complet ≤79
Désactivée
Support complet ≤79
Désactivée
Désactivée From version ≤79: this feature is behind the #service-worker-payment-apps preference (needs to be set to Enabled).
Firefox ? IE Aucun support NonOpera ? Safari ? WebView Android Aucun support NonChrome Android Support complet 61
Désactivée
Support complet 61
Désactivée
Désactivée From version 61: this feature is behind the #service-worker-payment-apps preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.
Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android Aucun support Non
onfetch
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
oninstall
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
onmessage
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
onmessageerrorChrome ? Edge ? Firefox ? IE Aucun support NonOpera ? Safari ? WebView Android ? Chrome Android ? Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?
onnotificationclick
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
onnotificationclose
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
onpaymentrequest
Expérimentale
Chrome Support complet 57
Désactivée
Support complet 57
Désactivée
Désactivée From version 57: this feature is behind the #service-worker-payment-apps preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.
Edge Support complet ≤79
Désactivée
Support complet ≤79
Désactivée
Désactivée From version ≤79: this feature is behind the #service-worker-payment-apps preference (needs to be set to Enabled).
Firefox ? IE Aucun support NonOpera ? Safari ? WebView Android Aucun support NonChrome Android Support complet 57
Désactivée
Support complet 57
Désactivée
Désactivée From version 57: this feature is behind the #service-worker-payment-apps preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.
Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android Aucun support Non
onpush
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
onpushsubscriptionchange
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
onsync
Expérimentale
Chrome Support complet 49Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 49Chrome Android Support complet 49Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 5.0
push eventChrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
pushsubscriptionchange eventChrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
registration
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Support complet 11.1WebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Support complet 11.3Samsung Internet Android Support complet 4.0
skipWaiting
Expérimentale
Chrome Support complet 40Edge Support complet ≤79Firefox 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 24Safari Aucun support NonWebView Android Support complet 40Chrome Android Support complet 40Firefox Android Support complet 44Opera Android Support complet 24Safari iOS Aucun support NonSamsung Internet Android Support complet 4.0

Légende

Support complet  
Support complet
Aucun support  
Aucun support
Compatibilité inconnue  
Compatibilité inconnue
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é.

See also