ServiceWorkerRegistration

例項屬性

也繼承自其父介面 EventTarget 的屬性。

ServiceWorkerRegistration.active 只讀

返回一個狀態為 activating 或 activated 的 Service Worker。該屬性初始值為 null。如果客戶端的 URL 落在註冊的範圍內（即在首次呼叫 ServiceWorkerContainer.register 時設定的 scope 選項），則活動 Service Worker 將控制該 Client。

ServiceWorkerRegistration.backgroundFetch 只讀 實驗性

返回一個指向 BackgroundFetchManager 物件的引用，該物件負責管理後臺獲取操作。

ServiceWorkerRegistration.cookies 只讀

返回一個指向 CookieStoreManager 介面的引用，該介面允許訂閱和取消訂閱 cookie 更改事件。

ServiceWorkerRegistration.index 只讀 實驗性

返回一個指向 ContentIndex 介面的引用，用於管理用於離線檢視的索引內容。

ServiceWorkerRegistration.installing 只讀

返回一個狀態為 installing 的 Service Worker。該屬性初始值為 null。

ServiceWorkerRegistration.navigationPreload 只讀

返回與當前 Service Worker 註冊關聯的 NavigationPreloadManager 例項。

ServiceWorkerRegistration.paymentManager 只讀 實驗性

返回一個支付應用的 PaymentManager 例項，用於管理各種支付應用功能。

ServiceWorkerRegistration.periodicSync 只讀 實驗性

返回一個指向 PeriodicSyncManager 介面的引用，該介面允許註冊在特定時間間隔執行的任務。

ServiceWorkerRegistration.pushManager 只讀

返回一個指向 PushManager 介面的引用，用於管理推送訂閱，包括訂閱、獲取當前訂閱和訪問推送許可權狀態。

ServiceWorkerRegistration.scope 只讀

返回一個字串，表示定義 Service Worker 註冊範圍的 URL；也就是說，Service Worker 可以控制的 URL 範圍。

ServiceWorkerRegistration.sync 只讀

返回一個指向 SyncManager 介面的引用，該介面負責管理後臺同步程序。

ServiceWorkerRegistration.updateViaCache 只讀

返回用於確定在嘗試更新 Service Worker 或透過 importScripts() 匯入的任何指令碼時，瀏覽器將如何查詢 HTTP 快取的設定值。它可以是以下值之一：imports、all 或 none。

ServiceWorkerRegistration.waiting 只讀

返回一個狀態為 installed 的 Service Worker。該屬性初始值為 null。

例項方法

也繼承自其父介面 EventTarget 的方法。

ServiceWorkerRegistration.getNotifications()

從當前來源通過當前 Service Worker 註冊建立的通知列表，按建立順序返回。

ServiceWorkerRegistration.showNotification()

顯示帶有請求標題的通知。

ServiceWorkerRegistration.unregister()

登出 Service Worker 註冊並返回一個 Promise。Service Worker 在登出前將完成所有正在進行的活動。

ServiceWorkerRegistration.update()

檢查伺服器是否有更新版本的 Service Worker，而不查詢快取。

事件

updatefound

當 ServiceWorkerRegistration.installing 屬性獲取到一個新的 Service Worker 時，隨時觸發。

示例

在此示例中，程式碼首先檢查瀏覽器是否支援 Service Worker，如果支援則註冊一個。接下來，它添加了一個 updatefound 監聽器，在該監聽器中，它使用 Service Worker 註冊來監聽 Service Worker 狀態的進一步變化。如果 Service Worker 自上次註冊以來沒有改變，則不會觸發 updatefound 事件。

if ("serviceWorker" in navigator) {
  navigator.serviceWorker
    .register("/sw.js")
    .then((registration) => {
      registration.addEventListener("updatefound", () => {
        // If updatefound is fired, it means that there's
        // a new service worker being installed.
        const installingWorker = registration.installing;
        console.log(
          "A new service worker is being installed:",
          installingWorker,
        );

        // You can listen for changes to the installing service worker's
        // state via installingWorker.onstatechange
      });
    })
    .catch((error) => {
      console.error(`Service worker registration failed: ${error}`);
    });
} else {
  console.error("Service workers are not supported.");
}

規範

瀏覽器相容性

另見

• 使用 Service Workers
• Service Worker 基本程式碼示例
• 使用 Web Worker