跳转到主要内容

类:ServiceWorkers

Class: ServiceWorkers

查询并接收来自会话中活动 Service Worker 的事件。

进程:主进程
此类未从 '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 Event
  • messageDetails Object - 有关控制台消息的信息
    • message string - 实际的控制台消息
    • versionId number - 发送日志消息的 Service Worker 的版本 ID
    • source string - 此消息的来源类型。可以是 javascriptxmlnetworkconsole-apistoragerenderingsecuritydeprecationworkerviolationinterventionrecommendationother
    • level number - 日志级别,从 0 到 3。依次对应 verboseinfowarningerror
    • sourceUrl string - 消息的来源 URL
    • lineNumber number - 触发此控制台消息的来源行号

当 Service Worker 向控制台记录内容时发出。

Event: 'registration-completed'

返回

  • event Event
  • details Object - 有关已注册 Service Worker 的信息
    • scope string - Service Worker 注册的基础 URL

当 Service Worker 成功注册时发出。可能在调用 navigator.serviceWorker.register('/sw.js') 解析后,或在加载 Chrome 扩展时发生。

Event: 'running-status-changed' Experimental

返回

  • details 事件<>
    • versionId number - 已更新 Service Worker 版本的 ID
    • runningStatus string - 运行状态。可能的值包括 startingrunningstoppingstopped

当 Service Worker 的运行状态发生变化时发出。

实例方法

ServiceWorkers 实例可用的方法如下:

serviceWorkers.getAllRunning()

返回 Record<number, ServiceWorkerInfo> - 一个 ServiceWorkerInfo 对象,其中键是 Service Worker 的版本 ID,值是有关该 Service Worker 的信息。

serviceWorkers.getInfoFromVersionID(versionId)

  • versionId number - Service Worker 版本的 ID

返回 ServiceWorkerInfo - 有关此 Service Worker 的信息

如果 Service Worker 不存在或未运行,此方法将抛出异常。

serviceWorkers.getFromVersionID(versionId) Deprecated

  • versionId number - Service Worker 版本的 ID

返回 ServiceWorkerInfo - 有关此 Service Worker 的信息

如果 Service Worker 不存在或未运行,此方法将抛出异常。

已弃用:请使用新的 serviceWorkers.getInfoFromVersionID API。

serviceWorkers.getWorkerFromVersionID(versionId) Experimental

  • versionId number - Service Worker 版本的 ID

返回 ServiceWorkerMain | undefined - 与给定版本 ID 关联的 Service Worker 实例。如果不存在关联的版本,或其运行状态已更改为 'stopped',则返回 undefined

serviceWorkers.startWorkerForScope(scope) Experimental

  • scope string - 要启动的 Service Worker 的范围。

返回 Promise<ServiceWorkerMain> - 解析为 Service Worker 实例,当它启动时。

启动 Service Worker,如果已运行则不做任何操作。

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)
}
}
})