1---
2category: '@Electron'
3---
4 
5# useIpcRendererOn
6 
7Use [ipcRenderer.on](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener) with ease and [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
8 
9## Usage
10 
11```ts
12import { useIpcRendererOn } from '@vueuse/electron'
13 
14// enable nodeIntegration if you don't provide ipcRenderer explicitly
15// see: https://www.electronjs.org/docs/api/webview-tag#nodeintegration
16// remove listener automatically on unmounted
17useIpcRendererOn('custom-event', (event, ...args) => {
18  console.log(args)
19})
20```
21 
22## Type Declarations
23 
24```ts
25/**
26 * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
27 * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
28 *
29 * You need to provide `ipcRenderer` to this function.
30 *
31 * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
32 * @see https://vueuse.org/useIpcRendererOn
33 */
34export declare function useIpcRendererOn(
35  ipcRenderer: IpcRenderer,
36  channel: string,
37  listener: IpcRendererListener,
38): IpcRenderer
39/**
40 * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
41 * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
42 *
43 * `ipcRenderer` will be automatically gotten.
44 *
45 * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
46 * @see https://vueuse.org/useIpcRendererOn
47 */
48export declare function useIpcRendererOn(
49  channel: string,
50  listener: IpcRendererListener,
51): IpcRenderer
52```
53