Aller au contenu principal

Class: ServiceWorkers

Class: ServiceWorkers

Interroge et reçoit des événements à partir d'un service worker actif d'une session.

Processus : Principal
Cette classe n'est pas exportée depuis le module 'electron'. Elle n'est disponible qu'en tant que valeur de retour des autres méthodes dans l'API Electron.

Les instances de la classe ServiceWorkers sont accessibles à l'aide de la propriété serviceWorkers d'une Session.

Par exemple :

const { session } = require('electron')

// Récupère tous les service workers.
console.log(session.defaultSession.serviceWorkers.getAllRunning())

// gère les logs et récupère les infos des service worker
session.defaultSession.serviceWorkers.on('console-message', (event, messageDetails) => {
console.log(
'Got service worker message',
messageDetails,
'from',
session.defaultSession.serviceWorkers.getFromVersionID(messageDetails.versionId)
)
})

Événements d’instance

Les événements suivants sont disponibles pour les instances de ServiceWorkers :

Événement : 'console-message'

Retourne :

  • event Event
  • Objet messageDetails - Informations sur le message de la console
    • message string - Message actuel de la console
    • versionId number - L'ID de version du service worker qui a envoyé le message de log
    • source string - Le type de source de ce message. Peut prendre une des valeurs suivantes: javascript, xml, network,console-api, storage, rendering, security, deprecation, worker,violation, intervention, recommendation ou,other, , ,, , ,.
    • level Integer - Le niveau de logging, de 0 à 3. Correspondant dans l'ordre croissant à verbose, info, warning et error.
    • Chaîne sourceUrl - L'URL de laquelle le message a été envoyé
    • lineNumber number - Le numéro de ligne du source qui a déclenché ce message de la console

Émis lorsqu'un service worker log quelque chose dans la console.

Événement : 'registration-completed'

Retourne :

  • event Event
  • Objet details - Informations sur le service worker enregistré
    • scope string - L'URL de base pour laquelle un service worker est enregistré

Émis lorsqu'un service worker a été enregistré. Peut se produire après un appel à navigator.serviceWorker.register('/sw.js') qui se résout avec succès ou quand une extension Chrome est chargée.

Méthodes d’instance

Les méthodes suivants sont disponibles pour les instances de ServiceWorkers :

serviceWorkers.getAllRunning()

Retourne Record<number, ServiceWorkerInfo>, un objet ServiceWorkerInfo où les clés sont l'ID de la version du serveur et les valeurs sont les informations à propos de ce service worker.

serviceWorkers.getFromVersionID(versionId)

  • versionId number

Retourne ServiceWorkerInfo - Informations sur ce service worker

Si le service worker n'existe pas ou n'exécute pas cette méthode, une exception sera levée.