mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1
electron/docs/api/ipc-main-service-worker.md
Sam Maddock 26da3c5d6e
feat: service worker preload scripts for improved extensions support (#44411) 
* feat: preload scripts for service workers

* feat: service worker IPC

* test: service worker preload scripts and ipc
2025-01-31 09:32:45 -05:00

2.3 KiB
Raw Blame History

Class: IpcMainServiceWorker

Communicate asynchronously from the main process to service workers.

Process: Main

Note

This API is a subtle variation of IpcMain—targeted for communicating with service workers. For communicating with web frames, consult the IpcMain documentation.

Instance Methods

ipcMainServiceWorker.on(channel, listener)

Listens to channel, when a new message arrives listener would be called with listener(event, args...).

ipcMainServiceWorker.once(channel, listener)

Adds a one time listener function for the event. This listener is invoked only the next time a message is sent to channel, after which it is removed.

ipcMainServiceWorker.removeListener(channel, listener)

  • channel string
  • listener Function
    • ...args any[]

Removes the specified listener from the listener array for the specified channel.

ipcMainServiceWorker.removeAllListeners([channel])

  • channel string (optional)

Removes listeners of the specified channel.

ipcMainServiceWorker.handle(channel, listener)

ipcMainServiceWorker.handleOnce(channel, listener)

Handles a single invokeable IPC message, then removes the listener. See ipcMainServiceWorker.handle(channel, listener).

ipcMainServiceWorker.removeHandler(channel)

  • channel string

Removes any handler for channel, if present.