类：ServiceWorkers

类：ServiceWorkers

🌐 Class: ServiceWorkers

查询并接收来自会话活动服务工作线程的事件。

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

可以通过 Session 的 serviceWorkers 属性访问 ServiceWorkers 类的实例。

🌐 Instances of the ServiceWorkers class are accessed by using serviceWorkers property of a Session.

例如：

🌐 For example:

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

实例事件

🌐 Instance Events

以下事件可在 ServiceWorkers 实例上使用：

🌐 The following events are available on instances of ServiceWorkers:

Event: 'console-message'

返回：

🌐 Returns:

• event 活动
• messageDetails 对象 - 控制台消息的信息
  • message 字符串 - 实际的控制台消息
  • versionId编号 - 发送日志消息的服务工作线程的版本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 编号 - 触发此控制台消息的源代码行号

当服务工作线程将某些内容记录到控制台时发出。

🌐 Emitted when a service worker logs something to the console.

Event: 'registration-completed'

返回：

🌐 Returns:

• event 活动
• details 对象 - 已注册服务工作线程的信息
  • scope 字符串 - 服务工作线程注册的基础 URL

当服务工作线程已注册时触发。可以在调用 navigator.serviceWorker.register('/sw.js') 成功完成后发生，或者在加载 Chrome 扩展时发生。

🌐 Emitted when a service worker has been registered. Can occur after a call to navigator.serviceWorker.register('/sw.js') successfully resolves or when a Chrome extension is loaded.

Event: 'running-status-changed' Experimental

返回：

🌐 Returns:

• “details”事件<>
  • versionId 编号 - 已更新服务工作线程版本的 ID
  • runningStatus 字符串 - 运行状态。可能的值包括 starting、running、stopping 或 stopped。

当服务工作者的运行状态发生变化时发出。

🌐 Emitted when a service worker's running status has changed.

实例方法

🌐 Instance Methods

ServiceWorkers 实例上可用以下方法：

🌐 The following methods are available on instances of ServiceWorkers:

serviceWorkers.getAllRunning()

返回 Record<number, ServiceWorkerInfo> - 一个 ServiceWorkerInfo 对象，其中键是服务工作线程版本 ID，值是该服务工作线程的信息。

🌐 Returns Record<number, ServiceWorkerInfo> - A ServiceWorkerInfo object where the keys are the service worker version ID and the values are the information about that service worker.

serviceWorkers.getInfoFromVersionID(versionId)

• versionId 号码 - 服务工作线程版本的 ID

返回 ServiceWorkerInfo - 关于此服务工作者的信息

🌐 Returns ServiceWorkerInfo - Information about this service worker

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

🌐 If the service worker does not exist or is not running this method will throw an exception.

serviceWorkers.getFromVersionID(versionId) 已弃用

🌐 serviceWorkers.getFromVersionID(versionId) Deprecated

• versionId 号码 - 服务工作线程版本的 ID

返回 ServiceWorkerInfo - 关于此服务工作者的信息

🌐 Returns ServiceWorkerInfo - Information about this service worker

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

🌐 If the service worker does not exist or is not running this method will throw an exception.

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

serviceWorkers.getWorkerFromVersionID(versionId) 实验性

🌐 serviceWorkers.getWorkerFromVersionID(versionId) Experimental

• versionId 号码 - 服务工作线程版本的 ID

返回 ServiceWorkerMain | undefined - 与给定版本 ID 关联的服务工作者实例。如果没有关联的版本，或者其运行状态已更改为“已停止”，则将返回 undefined。

🌐 Returns ServiceWorkerMain | undefined - Instance of the service worker associated with the given version ID. If there's no associated version, or its running status has changed to 'stopped', this will return undefined.

serviceWorkers.startWorkerForScope(scope) 实验性

🌐 serviceWorkers.startWorkerForScope(scope) Experimental

• scope 字符串 - 要启动的服务工作线程的范围。

返回 Promise<ServiceWorkerMain> - 当服务工作线程启动时解析。

🌐 Returns Promise<ServiceWorkerMain> - Resolves with the service worker when it's started.

启动服务工作线程，如果已运行，则不执行任何操作。

🌐 Starts the service worker or does nothing if already running.

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