ContentIndexEvent: ContentIndexEvent() constructor

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() constructor creates a new ContentIndexEvent object whose type and other options are configured as specified.

Syntax

js
new ContentIndexEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers always set it to contentdelete.

options

An object that, in addition of the properties defined in ExtendableEvent(), has the following properties:

id

The id of the indexed content you want the ContentIndex object to remove.

Return value

A new ContentIndexEvent object configured using the given options.

Examples

This examples constructs a new ContentIndexEvent with the relevant id.

js
const removeData = {
  id: "unique-content-id",
};

const ciEvent = new ContentIndexEvent("contentdelete", removeData);

ciEvent.id; // should return 'unique-content-id'

Specifications

Specification
Content Index
# content-index-event

Browser compatibility

desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
ContentIndexEvent() constructor
Experimental

See also