Web/API/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	Status	Comment
Service WorkersThe definition of 'install' in that specification.	Working Draft

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
install event Experimental'	Chrome Full support 40	Edge Full support ≤79	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 24	Safari Full support 11.1	WebView Android Full support 40	Chrome Android Full support 40	Firefox Android Full support 44	Opera Android Full support 24	Safari iOS Full support 11.3	Samsung Internet Android Full support 4.0

Legend

Full support  

Full support

No support  

No support

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

See implementation notes.'

See implementation notes.

See also

• activate event
• ServiceWorkerGlobalScope
• Service Worker API

ServiceWorkerGlobalScope: install event by Mozilla Contributors is licensed under CC-BY-SA 2.5.