类：ServiceWorkers

类: ServiceWorkers

查询并接收来自会话中活动 Service 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 Event
• messageDetails 对象 - 关于控制台消息的信息
  • message 字符串 - 实际的控制台消息
  • versionId 数字 - 发送日志消息的 Service 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 数字 - 触发此控制台消息的源的行号

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

事件: 'registration-completed'

返回

• event Event
• details 对象 - 关于已注册 Service Worker 的信息
  • scope 字符串 - Service Worker 注册的基础 URL

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

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

返回

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

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

实例方法

ServiceWorkers 实例上可用的方法如下

serviceWorkers.getAllRunning()

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

serviceWorkers.getInfoFromVersionID(versionId)

• versionId 数字 - Service Worker 版本的 ID

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

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

serviceWorkers.getFromVersionID(versionId) 已弃用

• versionId 数字 - Service Worker 版本的 ID

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

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

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

serviceWorkers.getWorkerFromVersionID(versionId) 实验性

• versionId 数字 - Service Worker 版本的 ID

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

serviceWorkers.startWorkerForScope(scope) 实验性

• scope 字符串 - 要启动的 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)
    }
  }
})