ServiceWorkerRegistration
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.
The ServiceWorkerRegistration
interface of the ServiceWorker API (en-US) represents the service worker registration. You register a service worker to control one or more pages that share the same origin.
The lifetime of a service worker registration is beyond that of the ServiceWorkerRegistration
objects that represent them within the lifetime of their corresponding service worker clients. The browser maintains a persistent list of active ServiceWorkerRegistration
objects.
Note : This feature is available in Web Workers.
Properties
Also implements properties from its parent interface, EventTarget
.
ServiceWorkerRegistration.scope
Lecture seule-
Returns a unique identifier for a service worker registration. This must be on the same origin as the document that registers the
ServiceWorker
. ServiceWorkerRegistration.installing
(en-US)Lecture seule-
Returns a service worker whose state is
installing
. This is initially set tonull
. ServiceWorkerRegistration.waiting
(en-US)Lecture seule-
Returns a service worker whose state is
waiting
. This is initially set tonull
. ServiceWorkerRegistration.active
Lecture seule-
Returns a service worker whose state is either
activating
oractivated
. This is initially set tonull
. An active worker will control aServiceWorkerClient
(en-US) if the client's URL falls within the scope of the registration (thescope
option set whenServiceWorkerContainer.register
is first called.) -
Returns the instance of
NavigationPreloadManager
(en-US) associated with the current service worker registration. ServiceWorkerRegistration.pushManager
(en-US) Lecture seule-
Returns a reference to the
PushManager
(en-US) interface for managing push subscriptions including subscribing, getting an active subscription, and accessing push permission status. ServiceWorkerRegistration.sync
(en-US) Non-standard Lecture seule-
Returns a reference to the
SyncManager
interface, which manages background synchronization processes.
Unimplemented properties
serviceWorkerRegistration.periodicSync
(en-US) Non-standard Lecture seule-
Returns a reference to the
PeriodicSyncManager
(en-US) interface, which manages periodic background synchronization processes. This was mentioned as an idea in the SW explainer at some point, but as yet has not been implemented anywhere.
Event handlers
ServiceWorkerRegistration.onupdatefound
(en-US) Lecture seule-
An
EventListener
property called whenever an event of typeupdatefound
is fired; it is fired any time theServiceWorkerRegistration.installing
(en-US) property acquires a new service worker.
Methods
Also implements methods from its parent interface, EventTarget
.
ServiceWorkerRegistration.getNotifications()
-
Returns a
Promise
that resolves to an array ofNotification
objects. ServiceWorkerRegistration.showNotification()
-
Displays the notification with the requested title.
ServiceWorkerRegistration.update()
(en-US)-
Checks the server for an updated version of the service worker without consulting caches.
ServiceWorkerRegistration.unregister()
(en-US)-
Unregisters the service worker registration and returns a
Promise
. The service worker will finish any ongoing operations before it is unregistered.
Examples
In this example, the code first checks whether the browser supports service workers and if so registers one. Next, it adds and updatefound
event in which it uses the service worker registration to listen for further changes to the service worker's state. If the service worker hasn't changed since the last time it was registered, than the updatefound
event will not be fired.
if ('serviceWorker' in navigator) {
navigator.serviceWorker.register('/sw.js')
.then(function(registration) {
registration.addEventListener('updatefound', function() {
// If updatefound is fired, it means that there's
// a new service worker being installed.
var installingWorker = registration.installing;
console.log('A new service worker is being installed:',
installingWorker);
// You can listen for changes to the installing service worker's
// state via installingWorker.onstatechange
});
})
.catch(function(error) {
console.log('Service worker registration failed:', error);
});
} else {
console.log('Service workers are not supported.');
}
Spécifications
Specification |
---|
Service Workers # serviceworkerregistration-interface |
Push API # extensions-to-the-serviceworkerregistration-interface |
Compatibilité des navigateurs
BCD tables only load in the browser