Esta é uma tecnologia experimental
Verifique a tabela de compatibilidade entre Navegadores cuidadosamente antes de usar essa funcionalidade em produção.
O ServiceWorkerContainer
é a interface de ServiceWorker API 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
property used to determine whether or not the current page is actively controlled.
Properties
ServiceWorkerContainer.controller
Somente leitura- Returns a
ServiceWorker
object if its state isactivated
(the same object returned byServiceWorkerRegistration.active
). This property returnsnull
during a force-refresh request (Shift + refresh) or if there is no active worker.
ServiceWorkerContainer.ready
Somente leitura- 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
associated with the current page has anServiceWorkerRegistration.active
worker. Once that condition is met, it resolves with theServiceWorkerRegistration
.
Event handlers
ServiceWorkerContainer.oncontrollerchange
- Fired whenever a
controllerchange
event occurs — when the document's associatedServiceWorkerRegistration
acquires a newactive
worker. ServiceWorkerContainer.onerror
- Fired whenever an
error
event occurs in the associated service workers. ServiceWorkerContainer.onmessage
- Fired whenever a
message
event occurs — when incoming messages are received to theServiceWorkerContainer
object (e.g. via aMessagePort.postMessage()
call.)
Methods
ServiceWorkerContainer.register()
- Creates or updates a
ServiceWorkerRegistration
for the givenscriptURL
. ServiceWorkerContainer.getRegistration()
- Gets a
ServiceWorkerRegistration
object whose scope matches the provided document URL. If the method can't return aServiceWorkerRegistration
, it returns aPromise
. ServiceWorkerContainer.getRegistrations()
- Returns all
ServiceWorkerRegistration
objects associated with aServiceWorkerContainer
in an array. If the method can't returnServiceWorkerRegistration
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.
navigation.serviceWorker.oncontrollerchange = function() {
console.log('This page is now controlled by:', navigator.serviceWorker.controller);
};
} else {
console.log('Service workers are not supported.');
}
Specifications
Specification | Status | Comment |
---|---|---|
Service Workers The definition of 'ServiceWorkerContainer' in that specification. |
Rascunho atual | Initial definition. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | 40 | 44.0 (44.0)[1] | Não suportado | 27 | Não suportado |
Feature | Android Webview | Chrome for Android | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|---|
Basic support | 40 | 40 | 44.0 (44.0) | (Yes) | Não suportado | 27 | Não suportado |
[1] Service workers (and Push) have been disabled in the Firefox 45 and 52 Extended Support Releases (ESR.)