ServiceWorkerRegistration
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.
备注: This feature is available in Web Workers.
Properties
Also implements properties from its parent interface, EventTarget
.
ServiceWorkerRegistration.scope
(en-US) 只读-
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) 只读-
Returns a service worker whose state is
installing
. This is initially set tonull
. ServiceWorkerRegistration.waiting
(en-US) 只读-
Returns a service worker whose state is
installed
. This is initially set tonull
. ServiceWorkerRegistration.active
只读-
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.) serviceWorkerRegistration.periodicSync
(en-US) 非标准 只读-
Returns a reference to the
PeriodicSyncManager
(en-US) interface, which manages periodic background synchronization processes. ServiceWorkerRegistration.pushManager
只读-
Returns a reference to the
PushManager
interface for managing push subscriptions including subscribing, getting an active subscription, and accessing push permission status. ServiceWorkerRegistration.sync
(en-US) 非标准 只读-
Returns a reference to the
SyncManager
(en-US) interface, which manages background synchronization processes.
Event handlers
ServiceWorkerRegistration.onupdatefound
(en-US) 只读-
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()
(en-US)-
Returns a
Promise
that resolves to an array ofNotification
objects. ServiceWorkerRegistration.showNotification()
(en-US)-
Displays the notification with the requested title.
ServiceWorkerRegistration.update()
-
Checks the server for an updated version of the service worker without consulting caches.
ServiceWorkerRegistration.unregister()
-
Unregisters the service worker registration and returns a promise (see
Promise
). The service worker will finish any ongoing operations before it is unregistered.
Examples
This code snippet is from the service worker registration-events sample (live demo). The code checks to see if the browser supports service workers and if there's currently a service worker handling requests on this page for the current navigation.
Any new service workers are registered; if there's an existing service worker, the code overrides its default scope so that the registration applies to the current directory and everything underneath it. The example also reports any registration failures.
if ('serviceWorker' in navigator) {
document.querySelector('#availability').innerText = 'are';
document.querySelector('#controlled').innerText = navigator.serviceWorker.controller ? 'is' : 'is not';
navigator.serviceWorker.register('service-worker.js', {scope: './'}).then(function(registration) {
document.querySelector('#register').textContent = 'succeeded';
}).catch(function(error) {
document.querySelector('#register').textContent = 'failed: ' + error;
});
} else {
document.querySelector('#availability').innerText = 'are not';
}
Specifications
Specification |
---|
Service Workers # serviceworkerregistration-interface |
Push API # extensions-to-the-serviceworkerregistration-interface |
Browser compatibility
BCD tables only load in the browser