Service Workers

类：ServiceWorkers¶

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

进程：Main
该类未从 'electron' 模块导出。它只能作为 Electron API 中其他方法的返回值使用。

通过 Session 的 serviceWorkers 属性访问 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 Object - 控制台消息的相关信息
• message string - 实际的控制台消息
• versionId number - 发送日志消息的 Service Worker 的版本 ID
• source string - 此消息的来源类型。可以是 javascript、xml、network、console-api、storage、rendering、security、deprecation、worker、violation、intervention、recommendation 或 other。
• level number - 日志级别，从 0 到 3。按顺序分别对应 verbose、info、warning 和 error。
• sourceUrl string - 消息来源的 URL
• lineNumber number - 触发此控制台消息的源代码行号

当 Service Worker 向控制台记录日志时触发。

事件：'registration-completed'¶

返回值：

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

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

事件：'running-status-changed' 实验性¶

返回值：

• details Event\<>
• versionId number - 更新后的 Service Worker 版本的 ID
• runningStatus string - 运行状态。 可能的值包括 starting、running、stopping 或 stopped。

当 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) 已弃用¶

• versionId number - Service Worker 版本的 ID

返回值 ServiceWorkerInfo - 此 Service Worker 的相关信息

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

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

serviceWorkers.getWorkerFromVersionID(versionId) 实验性¶

• versionId number - Service Worker 版本的 ID

返回值 ServiceWorkerMain | undefined - 与给定版本 ID 关联的 Service Worker 实例。如果没有关联的版本，或其运行状态已变为 'stopped'，则返回 undefined。

serviceWorkers.startWorkerForScope(scope) 实验性¶

• scope string - 要启动的 Service Worker 的作用域。

返回值 Promise<ServiceWorkerMain> - 当 Service Worker 启动时，解析值为该 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)
    }
  }
})