e7b0a9ca8f
* feat: add API for receiving logs from service workers * feat: add new serviceWorkerContext APIs * chore: add missing #include's * refactor: rename serviceWorkerContext to serviceWorkers * chore: clean up based on review * chore: remove native_mate * chore: add tests for the service worker module * Update spec-main/api-service-workers-spec.ts Co-Authored-By: Jeremy Apthorp <jeremya@chromium.org> * chore: fix linting * chore: handle renames Co-authored-by: Jeremy Apthorp <nornagon@nornagon.net>
2.3 KiB
2.3 KiB
Class: ServiceWorkers
Query and receive events from a sessions active service workers.
Process: Main
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
The following events are available on instances of ServiceWorkers
:
Event: 'console-message'
Returns:
event
EventmessageDetails
Object - Information about the console messagemessage
String - The actual console messageversionId
Number - The version ID of the service worker that sent the log messagesource
String - The type of source for this message. Can bejavascript
,xml
,network
,console-api
,storage
,app-cache
,rendering
,security
,deprecation
,worker
,violation
,intervention
,recommendation
orother
.level
Number - The log level, from 0 to 3. In order it matchesverbose
,info
,warning
anderror
.sourceUrl
String - The URL the message came fromlineNumber
Number - The line number of the source that triggered this console message
Emitted when a service worker logs something to the console.
Instance Methods
The following methods are available on instances of 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.
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.