Firefox Tomorrow

web api event

ServiceWorkerGlobalScope: install event

View on MDN ↗

Secure contextAvailable in workers

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

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

addEventListener("install", (event) => { })

oninstall = (event) => { }

Event type

An ExtendableEvent. Inherits from Event.

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:

self.addEventListener("install", (event) => {
  event.waitUntil(
    caches
      .open("v1")
      .then((cache) =>
        cache.addAll([
          "/",
          "/index.html",
          "/style.css",
          "/app.js",
          "/image-list.js",
          "/star-wars-logo.jpg",
          "/gallery/",
          "/gallery/bountyHunters.jpg",
          "/gallery/myLittleVader.jpg",
          "/gallery/snowTroopers.jpg",
        ]),
      ),
  );
});

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

self.oninstall = (event) => {
  // …
};

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also