W3cubDocs

/Web APIs

ServiceWorkerRegistration: index property

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The index read-only property of the ServiceWorkerRegistration interface returns a reference to the ContentIndex interface, which allows for indexing of offline content.

Value

A ContentIndex object.

Examples

You can access the property from either your main script or the registered service worker.

Here is an example from the main script:

js

// reference registration
const registration = await navigator.serviceWorker.ready;

// feature detection
if ("index" in registration) {
  // Content Index API functionality
  const contentIndex = registration.index;
}

From the service worker:

js

// service worker script

const contentIndex = self.registration.index;

Specifications

Specification
Content Index
# dom-serviceworkerregistration-index

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
index No No No No No No 84 84 No 60 No 14.0

See also

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