ContentIndex: add() method
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 available in Web Workers.
The add() method of the ContentIndex interface registers an item with the content index.
Syntax
add(contentDescription) Parameters
contentDescription-
An
Objectcontaining the following data:id-
A unique
Stringidentifier. title-
A
Stringtitle for the item. Used in user-visible lists of content. description-
A
Stringdescription of the item. Used in user-visible lists of content. url-
A
Stringcontaining the URL of the corresponding HTML document. Needs to be under the scope of the current service worker. categoryOptional-
A
Stringdefining the category of content. Can be:''An emptyString, this is the default.homepagearticlevideoaudio
iconsOptional-
An
Arrayof image resources, defined as anObjectwith the following data:src-
A URL
Stringof the source image. sizesOptional-
A
Stringrepresentation of the image size. typeOptional-
The MIME type of the image.
labelOptional-
A string representing the accessible name of the icon.
Return value
Returns a Promise that resolves with undefined.
Exceptions
TypeError-
This exception is thrown in the following conditions:
- The service worker's registration is not present or the service worker does not contain a
FetchEvent. - One of
id,title,descriptionorurlparameter are missing, not of typeString, or an emptyString. - The
urlparameter is not same-origin policy with the service worker. - One of the items in
iconsare not an image type, or fetching one of the items iniconsfailed with a network error or decode error.
- The service worker's registration is not present or the service worker does not contain a
Examples
Here we're declaring an item in the correct format and creating an asynchronous function which uses the add method to register it with the content index.
// our content const item = { id: "post-1", url: "/posts/amet.html", title: "Amet consectetur adipisicing", description: "Repellat et quia iste possimus ducimus aliquid a aut eaque nostrum.", icons: [ { src: "/media/dark.png", sizes: "128x128", type: "image/png", }, ], category: "article", }; // our asynchronous function to add indexed content async function registerContent(data) { const registration = await navigator.serviceWorker.ready; // feature detect Content Index if (!registration.index) { return; } // register content try { await registration.index.add(data); } catch (e) { console.log("Failed to register content: ", e.message); } } The add method can also be used within the service worker scope.
// our content const item = { id: "post-1", url: "/posts/amet.html", title: "Amet consectetur adipisicing", description: "Repellat et quia iste possimus ducimus aliquid a aut eaque nostrum.", icons: [ { src: "/media/dark.png", sizes: "128x128", type: "image/png", }, ], category: "article", }; self.registration.index.add(item); Specifications
| Specification |
|---|
| Content Index # content-index-add |