useIpcRenderer

类别

@Electron

导出大小

492 B

包

@vueuse/electron

用法

🌐 Usage

TypeScript

import { useIpcRenderer
 } from '@vueuse/electron'
import { computed
 } from 'vue'

// enable nodeIntegration if you don't provide ipcRenderer explicitly
// see: https://www.electronjs.org/docs/api/webview-tag#nodeintegration
const ipcRenderer
 = useIpcRenderer
()

// Ref result will return
const result
 = ipcRenderer
.invoke
<string>('custom-channel', 'some data')
const msg
 = computed
(() => result
.value
?.msg)

// remove listener automatically on unmounted
ipcRenderer
.on
('custom-event', (event
, ...args
) => {
  console
.log
(args
)
})

import { useIpcRenderer } from '@vueuse/electron'
import { computed } from 'vue'
// enable nodeIntegration if you don't provide ipcRenderer explicitly
// see: https://www.electronjs.org/docs/api/webview-tag#nodeintegration
const ipcRenderer = useIpcRenderer()
// Ref result will return
const result = ipcRenderer.invoke('custom-channel', 'some data')
const msg = computed(() => result.value?.msg)
// remove listener automatically on unmounted
ipcRenderer.on('custom-event', (event, ...args) => {
  console.log(args)
})

可用方法

🌐 Available Methods

方法	描述
`on(channel, listener)`	监听通道。在卸载时自动移除监听器
`once(channel, listener)`	监听通道一次
`removeListener(channel, listener)`	移除特定监听器
`removeAllListeners(channel)`	移除通道的所有监听器
`send(channel, ...args)`	向主进程发送异步消息
`invoke(channel, ...args)`	发送消息并作为 `ShallowRef` 获取响应
`sendSync(channel, ...args)`	发送同步消息并作为 `ShallowRef` 获取响应
`postMessage(channel, message, transfer?)`	发送带可转移对象的消息
`sendTo(webContentsId, channel, ...args)`	发送至特定的 webContents
`sendToHost(channel, ...args)`	发送至 webview 主机

使用自定义 IpcRenderer

🌐 With Custom IpcRenderer

如果禁用 nodeIntegration，你可以显式传递 ipcRenderer 实例：

🌐 If nodeIntegration is disabled, you can pass the ipcRenderer instance explicitly:

import { useIpcRenderer
 } from '@vueuse/electron'
import { ipcRenderer
 } from 'electron'

const ipc
 = useIpcRenderer
(ipcRenderer
)

useIpcRenderer ​

用法 ​

可用方法 ​

使用自定义 IpcRenderer ​

useIpcRenderer

用法

可用方法

使用自定义 IpcRenderer