Skip to main content

Class: ServiceWorkers

Class: ServiceWorkers

Query and receive events from a sessions active service workers.从会话活动服务工作者查询和接收事件。

Process:进程:Main
This class is not exported from the 'electron' module. It is only available as a return value of other methods in the Electron API.此类不是从'electron'模块导出的。它只能作为Electron API中其他方法的返回值使用。

Instances of the ServiceWorkers class are accessed by using serviceWorkers property of a Session.通过使用SessionServiceWorkers属性来访问ServiceWorkers类的实例。

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实例事件

The following events are available on instances of ServiceWorkers:ServiceWorkers实例上提供以下事件:

Event: 'console-message'

Returns:返回:

  • event Event
  • messageDetails Object - Information about the console message有关控制台消息的信息
    • message string - The actual console message实际控制台消息
    • versionId number - The version ID of the service worker that sent the log message发送日志消息的服务工作程序的版本ID
    • source string - The type of source for this message. 此消息的源类型。Can be javascript, xml, network, console-api, storage, rendering, security, deprecation, worker, violation, intervention, recommendation or other.可以是javascriptxmlnetworkconsole-apistoragerenderingsecuritydeprecationworkerviolationinterventionrecommendationother
    • level number - The log level, from 0 to 3. 日志级别,从0到3。In order it matches verbose, info, warning and error.按照顺序,它匹配verboseinfowarningerror
    • sourceUrl string - The URL the message came from消息来自的URL
    • lineNumber number - The line number of the source that triggered this console message触发此控制台消息的源的行号

Emitted when a service worker logs something to the console.当服务工作人员将某些内容记录到控制台时发出。

Event: 'registration-completed'

Returns:返回:

  • event Event
  • details Object - Information about the registered service worker有关注册服务人员的信息
    • scope string - The base URL that a service worker is registered for服务工作人员注册的基本URL

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.navigator.serviceWorker.register('/sw.js')的调用成功解析后或加载Chrome扩展时可能发生。

Instance Methods实例方法

The following methods are available on instances of ServiceWorkers:以下方法可用于ServiceWorkers的实例:

serviceWorkers.getAllRunning()

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.ServiceWorkerInfo对象,其中键是服务工作者版本ID,值是有关该服务工作者的信息。

serviceWorkers.getFromVersionID(versionId)

  • versionId number

Returns 返回ServiceWorkerInfo - Information about this service worker有关此服务人员的信息

If the service worker does not exist or is not running this method will throw an exception.如果服务工作者不存在或没有运行,则此方法将引发异常。