跳至主要內容

類別:ServiceWorkers

類別:ServiceWorkers

查詢並接收來自工作階段活動服務工作人員的事件。

程序:主程序
此類別並未從 'electron' 模組匯出。它僅作為 Electron API 中其他方法的回傳值提供。

ServiceWorkers 類別的實例是透過使用 SessionserviceWorkers 屬性來存取。

例如

const { session } = require('electron')

// Get all service workers.
console.log(session.defaultSession.serviceWorkers.getAllRunning())

// Handle logs and get service worker info
session.defaultSession.serviceWorkers.on('console-message', (event, messageDetails) => {
console.log(
'Got service worker message',
messageDetails,
'from',
session.defaultSession.serviceWorkers.getFromVersionID(messageDetails.versionId)
)
})

實例事件

以下事件在 ServiceWorkers 的實例上可用

事件:'console-message'

回傳

  • event 事件
  • messageDetails 物件 - 關於主控台訊息的資訊
    • message 字串 - 實際的主控台訊息
    • versionId 數字 - 發送日誌訊息的服務工作人員的版本 ID
    • source 字串 - 此訊息的來源類型。可以是 javascriptxmlnetworkconsole-apistoragerenderingsecuritydeprecationworkerviolationinterventionrecommendationother
    • level 數字 - 日誌等級,從 0 到 3。依序對應 verboseinfowarningerror
    • sourceUrl 字串 - 訊息的來源 URL
    • lineNumber 數字 - 觸發此主控台訊息的來源程式碼行號

當服務工作人員將內容記錄到主控台時發出。

事件:'registration-completed'

回傳

  • event 事件
  • details 物件 - 關於已註冊服務工作人員的資訊
    • scope 字串 - 服務工作人員註冊的基礎 URL

當服務工作人員已註冊時發出。可能在呼叫 navigator.serviceWorker.register('/sw.js') 成功解析或載入 Chrome 擴充功能時發生。

事件:'running-status-changed' 實驗性

回傳

  • details 事件<>
    • versionId 數字 - 更新的服務工作人員版本 ID
    • runningStatus 字串 - 執行狀態。可能的值包括 startingrunningstoppingstopped

當服務工作人員的執行狀態已變更時發出。

實例方法

以下方法在 ServiceWorkers 的實例上可用

serviceWorkers.getAllRunning()

回傳 Record<number, ServiceWorkerInfo> - 一個 ServiceWorkerInfo 物件,其中鍵是服務工作人員版本 ID,值是有關該服務工作人員的資訊。

serviceWorkers.getInfoFromVersionID(versionId)

  • versionId 數字 - 服務工作人員版本 ID

回傳 ServiceWorkerInfo - 關於此服務工作人員的資訊

如果服務工作人員不存在或未執行,此方法將拋出例外。

serviceWorkers.getFromVersionID(versionId) 已棄用

  • versionId 數字 - 服務工作人員版本 ID

回傳 ServiceWorkerInfo - 關於此服務工作人員的資訊

如果服務工作人員不存在或未執行,此方法將拋出例外。

已棄用: 使用新的 serviceWorkers.getInfoFromVersionID API。

serviceWorkers.getWorkerFromVersionID(versionId) 實驗性

  • versionId 數字 - 服務工作人員版本 ID

回傳 ServiceWorkerMain | undefined - 與給定版本 ID 關聯的服務工作人員實例。如果沒有關聯的版本,或其執行狀態已變更為 'stopped',這將回傳 undefined

serviceWorkers.startWorkerForScope(scope) 實驗性

  • scope 字串 - 要啟動的服務工作人員的範圍。

回傳 Promise<ServiceWorkerMain> - 在服務工作人員啟動時解析。

啟動服務工作人員,如果已在執行則不執行任何操作。

const { app, session } = require('electron')
const { serviceWorkers } = session.defaultSession

// Collect service workers scopes
const workerScopes = Object.values(serviceWorkers.getAllRunning()).map((info) => info.scope)

app.on('browser-window-created', async (event, window) => {
for (const scope of workerScopes) {
try {
// Ensure worker is started
const serviceWorker = await serviceWorkers.startWorkerForScope(scope)
serviceWorker.send('window-created', { windowId: window.id })
} catch (error) {
console.error(`Failed to start service worker for ${scope}`)
console.error(error)
}
}
})