@vueuse/electron 8.9.4 → 9.0.0-beta.2

package/README.md

@@ -16,7 +16,7 @@ npm i <b>@vueuse/electron</b> electron
 
 <!--GENERATED LIST, DO NOT MODIFY MANUALLY-->
 <!--FUNCTIONS_LIST_STARTS-->
-  - [`useIpcRenderer`](https://vueuse.org/electron/useIpcRenderer/) — provides [ipcRenderer](https://www.electronjs.org/docs/api/ipc-renderer) and it's all APIs
+  - [`useIpcRenderer`](https://vueuse.org/electron/useIpcRenderer/) — provides [ipcRenderer](https://www.electronjs.org/docs/api/ipc-renderer) and all of its APIs
   - [`useIpcRendererInvoke`](https://vueuse.org/electron/useIpcRendererInvoke/) — reactive [ipcRenderer.invoke API](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args) result
   - [`useIpcRendererOn`](https://vueuse.org/electron/useIpcRendererOn/) — use [ipcRenderer.on](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener) with ease and [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted
   - [`useZoomFactor`](https://vueuse.org/electron/useZoomFactor/) — reactive [WebFrame](https://www.electronjs.org/docs/api/web-frame#webframe) zoom factor

package/index.d.ts

@@ -8,8 +8,6 @@ declare type IpcRendererListener = (event: IpcRendererEvent, ...args: any[]) =>
  * Result from useIpcRenderer
  *
  * @see https://www.electronjs.org/docs/api/ipc-renderer
- * @export
- * @interface UseIpcRendererReturn
  */
 interface UseIpcRendererReturn {
     /**
@@ -17,43 +15,30 @@ interface UseIpcRendererReturn {
      * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
      *
      * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
-     * @param {string} channel
-     * @param {IpcRendererListener} listener
-     * @returns {IpcRenderer}
      */
     on(channel: string, listener: IpcRendererListener): IpcRenderer;
     /**
      * Adds a one time listener function for the event. This listener is invoked only the next time a message is sent to channel, after which it is removed.
      *
      * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereroncechannel-listener
-     * @param {string} channel
-     * @param {(event: IpcRendererEvent, ...args: any[]) => void} listener
-     * @returns {IpcRenderer}
      */
     once(channel: string, listener: (event: IpcRendererEvent, ...args: any[]) => void): IpcRenderer;
     /**
      * Removes the specified listener from the listener array for the specified channel.
      *
      * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener
-     * @param {string} channel
-     * @param {(...args: any[]) => void} listener
-     * @returns {IpcRenderer}
      */
     removeListener(channel: string, listener: (...args: any[]) => void): IpcRenderer;
     /**
      * Removes all listeners, or those of the specified channel.
      *
      * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovealllistenerschannel
-     * @param {string} channel
-     * @returns {IpcRenderer}
      */
     removeAllListeners(channel: string): IpcRenderer;
     /**
      * Send an asynchronous message to the main process via channel, along with arguments.
      *
      * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendchannel-args
-     * @param {string} channel
-     * @param {...any[]} args
      */
     send(channel: string, ...args: any[]): void;
     /**
@@ -62,10 +47,6 @@ interface UseIpcRendererReturn {
      * As composition-api, it makes asynchronous operations look like synchronous.
      *
      * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
-     * @template T
-     * @param {string} channel
-     * @param {...any[]} args
-     * @returns {(Ref<T | null>)}
      */
     invoke<T>(channel: string, ...args: any[]): Ref<T | null>;
     /**
@@ -73,36 +54,24 @@ interface UseIpcRendererReturn {
      * Send a message to the main process via channel and expect a result synchronously.
      *
      * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendsyncchannel-args
-     * @template T
-     * @param {string} channel
-     * @param {...any[]} args
-     * @returns {(Ref<T | null>)}
      */
     sendSync<T>(channel: string, ...args: any[]): Ref<T | null>;
     /**
      * Send a message to the main process, optionally transferring ownership of zero or more MessagePort objects.
      *
      * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererpostmessagechannel-message-transfer
-     * @param {string} channel
-     * @param {*} message
-     * @param {MessagePort[]} [transfer]
      */
     postMessage(channel: string, message: any, transfer?: MessagePort[]): void;
     /**
      * Sends a message to a window with webContentsId via channel.
      *
      * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtowebcontentsid-channel-args
-     * @param {number} webContentsId
-     * @param {string} channel
-     * @param {...any[]} args
      */
     sendTo(webContentsId: number, channel: string, ...args: any[]): void;
     /**
      * Like ipcRenderer.send but the event will be sent to the <webview> element in the host page instead of the main process.
      *
      * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
-     * @param {string} channel
-     * @param {...any[]} args
      */
     sendToHost(channel: string, ...args: any[]): void;
 }
@@ -110,9 +79,7 @@ interface UseIpcRendererReturn {
  * Get the `ipcRenderer` module with all APIs.
  *
  * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
- * @export
- * @param {IpcRenderer} [ipcRenderer]
- * @returns {UseIpcRendererReturn}
+ * @see https://vueuse.org/useIpcRenderer
  */
 declare function useIpcRenderer(ipcRenderer?: IpcRenderer): UseIpcRendererReturn;
 
@@ -124,12 +91,7 @@ declare function useIpcRenderer(ipcRenderer?: IpcRenderer): UseIpcRendererReturn
  * You need to provide `ipcRenderer` to this function.
  *
  * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
- * @export
- * @template T
- * @param {IpcRenderer} ipcRenderer
- * @param {string} channel
- * @param {...any[]} args
- * @returns {(Ref<T | null>)}
+ * @see https://vueuse.org/useIpcRendererInvoke
  */
 declare function useIpcRendererInvoke<T>(ipcRenderer: IpcRenderer, channel: string, ...args: any[]): Ref<T | null>;
 /**
@@ -140,11 +102,7 @@ declare function useIpcRendererInvoke<T>(ipcRenderer: IpcRenderer, channel: stri
  * `ipcRenderer` will be automatically gotten.
  *
  * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
- * @export
- * @template T
- * @param {string} channel
- * @param {...any[]} args
- * @returns {(Ref<T | null>)}
+ * @see https://vueuse.org/useIpcRendererInvoke
  */
 declare function useIpcRendererInvoke<T>(channel: string, ...args: any[]): Ref<T | null>;
 
@@ -155,11 +113,7 @@ declare function useIpcRendererInvoke<T>(channel: string, ...args: any[]): Ref<T
  * You need to provide `ipcRenderer` to this function.
  *
  * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
- * @export
- * @param {IpcRenderer} ipcRenderer
- * @param {string} channel
- * @param {IpcRendererListener} listener
- * @returns {IpcRenderer}
+ * @see https://vueuse.org/useIpcRendererOn
  */
 declare function useIpcRendererOn(ipcRenderer: IpcRenderer, channel: string, listener: IpcRendererListener): IpcRenderer;
 /**
@@ -169,10 +123,7 @@ declare function useIpcRendererOn(ipcRenderer: IpcRenderer, channel: string, lis
  * `ipcRenderer` will be automatically gotten.
  *
  * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
- * @export
- * @param {string} channel
- * @param {IpcRendererListener} listener
- * @returns {IpcRenderer}
+ * @see https://vueuse.org/useIpcRendererOn
  */
 declare function useIpcRendererOn(channel: string, listener: IpcRendererListener): IpcRenderer;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vueuse/electron",
-  "version": "8.9.4",
+  "version": "9.0.0-beta.2",
   "description": "Electron renderer process modules for VueUse",
   "author": "Archer Gu<https://github.com/ArcherGu>",
   "license": "MIT",
@@ -37,7 +37,7 @@
     "electron": ">=9.0.0"
   },
   "dependencies": {
-    "@vueuse/shared": "8.9.4",
+    "@vueuse/shared": "9.0.0-beta.2",
     "vue-demi": "*"
   },
   "devDependencies": {