ServiceWorkerContainer
Experimental: Esta es una tecnología experimental
Comprueba la Tabla de compabilidad de navegadores cuidadosamente antes de usarla en producción.
The ServiceWorkerContainer
interface of the ServiceWorker API (en-US) provides an object representing the service worker as an overall unit in the network ecosystem, including facilities to register, unregister and update service workers, and access the state of service workers and their registrations.
Most importantly, it exposes the ServiceWorkerContainer.register()
method used to register service workers, and the ServiceWorkerContainer.controller
(en-US) property used to determine whether or not the current page is actively controlled.
Properties
ServiceWorkerContainer.controller
(en-US) Read only-
Returns a
ServiceWorker
(en-US) object if its state isactivated
(the same object returned byServiceWorkerRegistration.active
(en-US)). This property returnsnull
during a force-refresh request (Shift + refresh) or if there is no active worker.
ServiceWorkerContainer.ready
(en-US) Read only-
Provides a way of delaying code execution until a service worker is active. It returns a
Promise
that will never reject, and which waits indefinitely until theServiceWorkerRegistration
(en-US) associated with the current page has anServiceWorkerRegistration.active
(en-US) worker. Once that condition is met, it resolves with theServiceWorkerRegistration
(en-US).
Event handlers
ServiceWorkerContainer.oncontrollerchange
(en-US)-
Fired whenever a
controllerchange
event occurs — when the document's associatedServiceWorkerRegistration
(en-US) acquires a newactive
(en-US) worker. ServiceWorkerContainer.onerror
(en-US)-
Fired whenever an
error
(en-US) event occurs in the associated service workers. ServiceWorkerContainer.onmessage
(en-US)-
Fired whenever a
message
event occurs — when incoming messages are received to theServiceWorkerContainer
object (e.g. via aMessagePort.postMessage()
(en-US) call.)
Methods
ServiceWorkerContainer.register()
-
Creates or updates a
ServiceWorkerRegistration
(en-US) for the givenscriptURL
. ServiceWorkerContainer.getRegistration()
(en-US)-
Gets a
ServiceWorkerRegistration
(en-US) object whose scope matches the provided document URL. If the method can't return aServiceWorkerRegistration
(en-US), it returns aPromise
. ServiceWorkerContainer.getRegistrations()
(en-US)-
Returns all
ServiceWorkerRegistration
(en-US) objects associated with aServiceWorkerContainer
in an array. If the method can't returnServiceWorkerRegistration
(en-US) objects, it returns aPromise
.
Examples
The example below first checks to see if the browser supports service workers. If supported, the code registers the service worker and determines if the page is actively controlled by the service worker. If it isn't, it prompts the user to reload the page so the service worker can take control. The code also reports any registration failures.
if ('serviceWorker' in navigator) {
// Register a service worker hosted at the root of the
// site using the default scope.
navigator.serviceWorker.register('/sw.js').then(function(registration) {
console.log('Service worker registration succeeded:', registration);
// At this point, you can optionally do something
// with registration. See https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration
}).catch(function(error) {
console.log('Service worker registration failed:', error);
});
// Independent of the registration, let's also display
// information about whether the current page is controlled
// by an existing service worker, and when that
// controller changes.
// First, do a one-off check if there's currently a
// service worker in control.
if (navigator.serviceWorker.controller) {
console.log('This page is currently controlled by:', navigator.serviceWorker.controller);
}
// Then, register a handler to detect when a new or
// updated service worker takes control.
navigator.serviceWorker.oncontrollerchange = function() {
console.log('This page is now controlled by:', navigator.serviceWorker.controller);
};
} else {
console.log('Service workers are not supported.');
}
Especificaciones
Specification |
---|
Service Workers # serviceworkercontainer-interface |
Compatibilidad con navegadores
BCD tables only load in the browser