ContentIndexEvent: ContentIndexEvent() constructor

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

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

BCD tables only load in the browser

See also