大网数据广告活动
Web 标准与前端开发

ContentIndex: getAll() method

· 52CE 我爱测

The **`getAll()`** method of the ContentIndex interface returns a Promise that resolves with an iterable list of content index entries.

Content Index API

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

        • : A String defining the category of content. Can be:
          • '' An empty String, this is the default.
          • homepage
          • article
          • video
          • audio
      • icons

        • : An Array of image resources, defined as an Object with the following data:
          • src
            • : A URL String of the source image.
          • sizes
            • : A String representation of the image size.
          • type
            • : The MIME type of the image.
          • label
            • : A string representing the accessible name of the icon.

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

Browser compatibility

See also

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。