ServiceWorkerGlobalScope: install event

The install event of the ServiceWorkerGlobalScope interface is fired when a ServiceWorkerRegistration acquires a new ServiceWorkerRegistration.installing worker.

Bubbles No
Cancelable No
Interface ExtendableEvent
Event handler property ServiceWorkerGlobalScope.oninstall

Examples

The following snippet shows how an install event handler can be used to populate a cache with a number of responses, which the service worker can then use to serve assets offline:

this.addEventListener('install', function(event) {
  event.waitUntil(
   caches.open('v1').then(function(cache) {
      return cache.addAll([
        '/sw-test/',
        '/sw-test/index.html',
        '/sw-test/style.css',
        '/sw-test/app.js',
        '/sw-test/image-list.js',
        '/sw-test/star-wars-logo.jpg',
        '/sw-test/gallery/',
        '/sw-test/gallery/bountyHunters.jpg',
        '/sw-test/gallery/myLittleVader.jpg',
        '/sw-test/gallery/snowTroopers.jpg'
      ])
   })
   );
});

You can also set up the event handler using the ServiceWorkerGlobalScope.oninstall property:

globalScope.oninstall = function(event) {
  ...
};

Specifications

Specification
Service Workers 1
# service-worker-global-scope-install-event

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
install_event
40
≤79
44
Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
No
24
11.1
40
40
44
24
11.3
4.0

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/install_event