ContentIndex: getAll() method
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 getAll()
method of the
ContentIndex
interface returns a Promise
that resolves with
an iterable list of content index entries.
Syntax
getAll()
Parameters
None.
Return value
Returns a Promise
that resolves with an Array
of
contentDescription
items.
contentDescription
-
Each item returned is an
Object
containing the following data:id
-
A unique
String
identifier. title
-
A
String
title of the item. Used in user-visible lists of content. description
-
A
String
description of the item. Used in user-visible lists of content. url
-
A
String
containing the URL of the corresponding HTML document. Needs to be under the scope of the current service worker. category
Optional-
A
String
defining the category of content. Can be:''
An emptyString
, this is the default.homepage
article
video
audio
icons
Optional-
An
Array
of image resources, defined as anObject
with the following data:
Exceptions
No exceptions are thrown. If there are no items in the Content Index, an empty
Array
is returned.
Examples
The below example shows an asynchronous function that retrieves items within the content index and iterates over each entry, building a list for the interface.
async function createReadingList() {
// access our service worker registration
const registration = await navigator.serviceWorker.ready;
// get our index entries
const entries = await registration.index.getAll();
// create a containing element
const readingListElem = document.createElement("div");
// test for entries
if (entries.length === 0) {
// if there are no entries, display a message
const message = document.createElement("p");
message.innerText =
"You currently have no articles saved for offline reading.";
readingListElem.append(message);
} else {
// if entries are present, display in a list of links to the content
const listElem = document.createElement("ul");
for (const entry of entries) {
const listItem = document.createElement("li");
const anchorElem = document.createElement("a");
anchorElem.innerText = entry.title;
anchorElem.setAttribute("href", entry.url);
listElem.append(listItem);
}
readingListElem.append(listElem);
}
}
Specifications
Specification |
---|
Content Index # content-index-getall |
Browser compatibility
BCD tables only load in the browser