类: ServiceWorkers

类: ServiceWorkers

从会话活动的 service worker 中查询和接收事件。

进程: 主进程
该类不是从 '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 事件
• messageDetails 对象 - 关于控制台消息的信息
  • message 字符串 - 实际的控制台消息
  • versionId number - 发送日志消息的 service worker 的版本 ID
  • source 字符串 - 此消息的源类型。 可以是 javascript、xml、network、console-api、storage、rendering、security、deprecation、worker、violation、intervention、recommendation 或 other。
  • level number - 日志级别，从 0 到 3。 依次匹配 verbose、info、warning 和 error。
  • sourceUrl 字符串 - 消息来源的 URL
  • lineNumber number - 触发此控制台消息的源的行号

当 service worker 将内容记录到控制台时发出。

事件: 'registration-completed'

返回值

• event 事件
• details 对象 - 有关已注册 service worker 的信息
  • scope 字符串 - service worker 注册的基本 URL

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

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

返回值

• details 事件<>
  • versionId number - 已更新的 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 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 字符串 - 要启动的 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)
    }
  }
})