Skip to content

useIpcRendererInvoke

反应式 ipcRenderer.invoke API 结果。使异步操作看起来同步。

¥Reactive ipcRenderer.invoke API result. Make asynchronous operations look synchronous. Available in the @vueuse/electron add-on.

用法

¥Usage

ts
import { 
useIpcRendererInvoke
} 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 // Ref result will return const
result
=
useIpcRendererInvoke
<string>('custom-channel', 'some data')
const
msg
=
computed
(() =>
result
.
value
?.msg)
js
import { useIpcRendererInvoke } 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
// Ref result will return
const result = useIpcRendererInvoke('custom-channel', 'some data')
const msg = computed(() => result.value?.msg)

类型声明

显示类型声明
ts
/**
 * Returns Promise<any> - Resolves with the response from the main process.
 *
 * Send a message to the main process via channel and expect a result ~~asynchronously~~. As composition-api, it makes asynchronous operations look like synchronous.
 *
 * You need to provide `ipcRenderer` to this function.
 *
 * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
 * @see https://vueuse.org/useIpcRendererInvoke
 */
export declare function 
useIpcRendererInvoke
<
T
>(
ipcRenderer
:
IpcRenderer
,
channel
: string,
...
args
: any[]
):
ShallowRef
<
T
| null>
/** * Returns Promise<any> - Resolves with the response from the main process. * * Send a message to the main process via channel and expect a result ~~asynchronously~~. As composition-api, it makes asynchronous operations look like synchronous. * * `ipcRenderer` will be automatically gotten. * * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args * @see https://vueuse.org/useIpcRendererInvoke */ export declare function
useIpcRendererInvoke
<
T
>(
channel
: string,
...
args
: any[]
):
ShallowRef
<
T
| null>

源代码

源代码文档

变更日志

d32f8 - refactor: add @__NO_SIDE_EFFECTS__ annotations to all pure functions (#4907)