ServiceWorkerRegistration.index

Draft: This page is not complete.

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

Syntax

var contentIndexObject = ServiceWorkerRegistration.index;

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:

// 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:

// 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	Yes	Yes	No	Yes	No	No