ContentIndexEvent

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

Note: This feature is only available in Service Workers.

The ContentIndexEvent interface of the content index defines the object used to represent the contentdelete event.

This event is sent to the global scope of a ServiceWorker. It contains the id of the indexed content to be removed.

The contentdelete event is only fired when the deletion happens due to interaction with the browser's built-in user interface. It is not fired when the ContentIndex.delete method is called.

Event ExtendableEvent ContentIndexEvent

Constructor

ContentIndexEvent() Experimental

Creates and returns a new ContentIndexEvent object whose type and other options are configured as specified.

Instance properties

In addition to the properties listed below, this interface inherits the properties of its parent interface, ExtendableEvent.

id Read only Experimental

A String which identifies the deleted content index via it's id.

Instance methods

While ContentIndexEvent offers no methods of its own, it inherits any specified by its parent interface, ExtendableEvent.

Examples

This example shows the service worker script listening for the contentdelete event and logs the removed content index id.

js
self.addEventListener("contentdelete", (event) => {
  console.log(event.id);

  // logs content index id, which can then be used to determine what content to delete from your cache
});

Specifications

Specification
Content Index
# content-index-event

Browser compatibility

BCD tables only load in the browser

See also