useIpcRendererOn
| Category | @Electron |
|---|---|
| Export Size | 242 B |
| Package | @vueuse/electron |
| Last Changed | last week |
Use ipcRenderer.on with ease and ipcRenderer.removeListener automatically on unmounted. Available in the @vueuse/electron add-on.
Usage
import { useIpcRendererOn } from '@vueuse/electron'
// enable nodeIntegration if you don't provide ipcRenderer explicitly
// @see: https://www.electronjs.org/docs/api/webview-tag#nodeintegration
// remove listener automatically on unmounted
useIpcRendererOn('custom-event', (event, ...args) => {
console.log(args)
})Type Declarations
/**
* 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
*/
export declare function 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](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
*
* `ipcRenderer` will be automatically gotten.
*
* @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
* @see https://vueuse.org/useIpcRendererOn
*/
export declare function useIpcRendererOn(
channel: string,
listener: IpcRendererListener
): IpcRendererSource
© 2019-present Anthony Fu
Licensed under the MIT License.
https://vueuse.org/electron/useIpcRendererOn/