useIpcRendererOn

分类

@Electron

导出大小

267 B

包

@vueuse/electron

最后更改

6 个月前

轻松使用 ipcRenderer.on，并在卸载时自动 ipcRenderer.removeListener。在 @vueuse/electron 附加组件中可用。

用法

import { useIpcRendererOn } from '@vueuse/electron'

// enable nodeIntegration if you don't provide ipcRenderer explicitly
// @see: https://electron.js.cn/docs/api/webview-tag#nodeintegration
// remove listener automatically on unmounted
useIpcRendererOn('custom-event', (event, ...args) => {
  console.log(args)
})

类型声明

显示类型声明

typescript

/**
 * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
 * [ipcRenderer.removeListener](https://electron.js.cn/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
 *
 * You need to provide `ipcRenderer` to this function.
 *
 * @see https://electron.js.cn/docs/api/ipc-renderer#ipcrendereronchannel-listener
 * @see https://vueuse.org.cn/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://electron.js.cn/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
 *
 * `ipcRenderer` will be automatically gotten.
 *
 * @see https://electron.js.cn/docs/api/ipc-renderer#ipcrendereronchannel-listener
 * @see https://vueuse.org.cn/useIpcRendererOn
 */
export declare function useIpcRendererOn(
  channel: string,
  listener: IpcRendererListener,
): IpcRenderer