useIpcRendererOn

Category

@Electron

Export Size

277 B

Package

@reause/electron

Last Changed

5 days ago

Use ipcRenderer.on with ease and ipcRenderer.removeListener automatically on unmounted.

Demo

Usage

import { useIpcRendererOn } from '@reause/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

export type IpcRendererListener = (event: IpcRendererEvent, ...args: any[]) => void

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

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

Source

Source · Demo · VueUse

Contributors

Changelog

v0.1.0 on

c807f - fix(electron): resolve useIpcRendererOn audit findings (#810)

9a6d8 - feat(electron): add useIpcRenderer, useIpcRendererInvoke, useIpcRendererOn (#148, #149, #150)