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.dev.org.tw/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.dev.org.tw/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
 *
 * You need to provide `ipcRenderer` to this function.
 *
 * @see https://electron.dev.org.tw/docs/api/ipc-renderer#ipcrendereronchannel-listener
 * @see https://vueuse.dev.org.tw/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.dev.org.tw/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
 *
 * `ipcRenderer` will be automatically gotten.
 *
 * @see https://electron.dev.org.tw/docs/api/ipc-renderer#ipcrendereronchannel-listener
 * @see https://vueuse.dev.org.tw/useIpcRendererOn
 */
export declare function useIpcRendererOn(
  channel: string,
  listener: IpcRendererListener,
): IpcRenderer