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 | Status | Comment |
Content Index APIThe definition of 'index' in that specification. | Editor's Draft | Initial definition. |
Browser compatibility
The compatibility table in 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.
No compatibility data found. Please contribute data for "api.ServiceWorkerRegistration.index" (depth: 1) to the MDN compatibility data repository.
See also
Content Index API
- An introductory article on the Content Index API
- An app which uses the Content Index API to list and remove 'save for later' content
ServiceWorkerRegistration.index by Mozilla Contributors is licensed under CC-BY-SA 2.5.