useIpcRendererInvoke

類別

@Electron

導出大小

213 B

套件

@vueuse/electron

上次變更

3 週前

響應式 ipcRenderer.invoke API 結果。使非同步操作看起來像是同步的。可在 @vueuse/electron 附加元件中使用。

用法

TypeScript

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

// enable nodeIntegration if you don't provide ipcRenderer explicitly
// @see: https://electron.dev.org.tw/docs/api/webview-tag#nodeintegration
// Ref result will return
const result = useIpcRendererInvoke<string>('custom-channel', 'some data')
const msg = computed(() => result.value?.msg)

import { useIpcRendererInvoke } from '@vueuse/electron'
import { computed } from 'vue'
// enable nodeIntegration if you don't provide ipcRenderer explicitly
// @see: https://electron.dev.org.tw/docs/api/webview-tag#nodeintegration
// Ref result will return
const result = useIpcRendererInvoke('custom-channel', 'some data')
const msg = computed(() => result.value?.msg)

類型宣告

顯示類型宣告

typescript

/**
 * 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://electron.dev.org.tw/docs/api/ipc-renderer#ipcrendererinvokechannel-args
 * @see https://vueuse.dev.org.tw/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://electron.dev.org.tw/docs/api/ipc-renderer#ipcrendererinvokechannel-args
 * @see https://vueuse.dev.org.tw/useIpcRendererInvoke
 */
export declare function useIpcRendererInvoke<T>(
  channel: string,
  ...args: any[]
): ShallowRef<T | null>