⬅️ Back to Table of Contents

📄 useIpcRendererOn

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	3

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

📂 packages/electron/useIpcRendererOn/index.ts

📦 Imports

Name	Source
IpcRenderer	electron
IpcRendererListener	../_types
tryOnScopeDispose	@vueuse/shared

---

Functions

useIpcRendererOn(ipcRenderer: IpcRenderer, channel: string, listener: IpcRendererListener): IpcRenderer

Listens to channel, when a new message arrives listener would be called with listener(event, args...). ipcRenderer.removeListener automatically on unmounted.

You need to provide ipcRenderer to this function.

See: https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener, https://vueuse.org/useIpcRendererOn

Raw JSDoc

/**
 * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
 * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
 *
 * You need to provide `ipcRenderer` to this function.
 *
 * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
 * @see https://vueuse.org/useIpcRendererOn
 */

Code

export function useIpcRendererOn(ipcRenderer: IpcRenderer, channel: string, listener: IpcRendererListener): IpcRenderer

---

Generated by Syntax Scribe