ServiceWorkerGlobalScope: skipWaiting() method
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is only available in Service Workers.
The skipWaiting()
method of the ServiceWorkerGlobalScope
interface forces the waiting service worker to become the active service worker.
Use this method with Clients.claim()
to ensure that updates to the underlying service worker take effect immediately for both the current client and all other active clients.
Syntax
skipWaiting()
Parameters
None.
Return value
A Promise
that resolves with undefined
after trying to activate the newly installed service worker.
Examples
While self.skipWaiting()
can be called at any point during the service worker's execution, it will only have an effect if there's a newly installed service worker that might otherwise remain in the waiting
state. Therefore, it's common to call self.skipWaiting()
from inside of an InstallEvent
handler.
The following example causes a newly installed service worker to progress into the activating
state, regardless of whether there is already an active service worker.
self.addEventListener("install", (event) => {
// The promise that skipWaiting() returns can be safely ignored.
self.skipWaiting();
// Perform any other actions required for your
// service worker to install, potentially inside
// of event.waitUntil();
});
Specifications
Specification |
---|
Service Workers # service-worker-global-scope-skipwaiting |
Browser compatibility
BCD tables only load in the browser