类: ServiceWorkers

查询和接收来自会话活动服务 Worker 的事件。

进程: 主进程
此类未从 'electron' 模块导出。它仅作为 Electron API 中其他方法的返回值提供。

ServiceWorkers 类的实例通过使用 Session 的 serviceWorkers 属性访问。

例如

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 数字 - 发送日志消息的服务 Worker 的版本 ID
- source 字符串 - 此消息的来源类型。可以是 javascript、xml、network、console-api、storage、rendering、security、deprecation、worker、violation、intervention、recommendation 或 other。
- level 数字 - 日志级别，从 0 到 3。按顺序匹配 verbose、info、warning 和 error。
- sourceUrl 字符串 - 消息来源的 URL
- lineNumber 数字 - 触发此控制台消息的源的行号

当服务 Worker 向控制台记录内容时触发。

事件: 'registration-completed'

event 事件
details 对象 - 关于已注册服务 Worker 的信息
- scope 字符串 - 服务 Worker 注册的基础 URL

当服务 Worker 已注册时触发。可以在成功解析对 navigator.serviceWorker.register('/sw.js') 的调用之后或加载 Chrome 扩展程序时发生。

事件: 'running-status-changed' 实验性

details 事件<>
- versionId 数字 - 更新的服务 Worker 版本的 ID
- runningStatus 字符串 - 运行状态。可能的值包括 starting、running、stopping 或 stopped。

当服务 Worker 的运行状态已更改时触发。

实例方法

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

`serviceWorkers.getAllRunning()`

返回 Record<number, ServiceWorkerInfo> - ServiceWorkerInfo 对象，其中键是服务 Worker 版本 ID，值是关于该服务 Worker 的信息。

`serviceWorkers.getInfoFromVersionID(versionId)`

versionId 数字 - 服务 Worker 版本的 ID

返回 ServiceWorkerInfo - 关于此服务 Worker 的信息

如果服务 Worker 不存在或未运行，则此方法将抛出异常。

`serviceWorkers.getFromVersionID(versionId)` 已弃用

versionId 数字 - 服务 Worker 版本的 ID

返回 ServiceWorkerInfo - 关于此服务 Worker 的信息

如果服务 Worker 不存在或未运行，则此方法将抛出异常。

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

`serviceWorkers.getWorkerFromVersionID(versionId)` 实验性

versionId 数字 - 服务 Worker 版本的 ID

返回 ServiceWorkerMain | undefined - 与给定版本 ID 关联的服务 Worker 的实例。如果不存在关联的版本，或者其运行状态已更改为“stopped”，则将返回 undefined。

`serviceWorkers.startWorkerForScope(scope)` 实验性

scope 字符串 - 要启动的服务 Worker 的作用域。

返回 Promise<ServiceWorkerMain> - 在服务 Worker 启动时解析。

启动服务 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)
    }
  }
})