@vueuse/electron 10.2.1 → 10.4.0

package/index.cjs

@@ -49,7 +49,7 @@ function setSendSync(ipcRenderer) {
 }
 function useIpcRenderer(ipcRenderer) {
   if (!ipcRenderer)
-    ipcRenderer = window == null ? void 0 : window.require("electron").ipcRenderer;
+    ipcRenderer = window?.require("electron").ipcRenderer;
   if (!ipcRenderer)
     throw new Error("provide IpcRenderer module or enable nodeIntegration");
   return {
@@ -80,14 +80,14 @@ function useZoomFactor(...args) {
     throw new Error("provide WebFrame module or enable nodeIntegration");
   if (newFactor && newFactor.value === 0)
     throw new Error("the factor must be greater than 0.0.");
-  const factor = vueDemi.ref(newFactor != null ? newFactor : webFrame.getZoomFactor());
+  const factor = vueDemi.ref(newFactor ?? webFrame.getZoomFactor());
   vueDemi.watch(
     factor,
     (f, o) => {
       if (typeof f === "number" && f === 0)
         throw new Error("the factor must be greater than 0.0.");
       if (typeof f === "number" && f !== o)
-        webFrame == null ? void 0 : webFrame.setZoomFactor(f);
+        webFrame?.setZoomFactor(f);
     },
     { immediate: true }
   );
@@ -106,12 +106,12 @@ function useZoomLevel(...args) {
   }
   if (!webFrame)
     throw new Error("provide WebFrame module or enable nodeIntegration");
-  const level = vueDemi.ref(newLevel != null ? newLevel : webFrame.getZoomLevel());
+  const level = vueDemi.ref(newLevel ?? webFrame.getZoomLevel());
   vueDemi.watch(
     level,
     (f, o) => {
       if (typeof f === "number" && f !== o)
-        webFrame == null ? void 0 : webFrame.setZoomLevel(f);
+        webFrame?.setZoomLevel(f);
     },
     { immediate: true }
   );

package/index.d.cts

@@ -0,0 +1,140 @@
+import { IpcRendererEvent, IpcRenderer, WebFrame } from 'electron';
+import { Ref } from 'vue-demi';
+import { MaybeRef } from '@vueuse/shared';
+
+type IpcRendererListener = (event: IpcRendererEvent, ...args: any[]) => void;
+
+/**
+ * Result from useIpcRenderer
+ *
+ * @see https://www.electronjs.org/docs/api/ipc-renderer
+ */
+interface UseIpcRendererReturn {
+    /**
+     * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
+     * [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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    send(channel: string, ...args: any[]): void;
+    /**
+     * 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.
+     *
+     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
+     */
+    invoke<T>(channel: string, ...args: any[]): Ref<T | null>;
+    /**
+     * Returns any - The value sent back by the ipcMain handler.
+     * 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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    sendToHost(channel: string, ...args: any[]): void;
+}
+/**
+ * Get the `ipcRenderer` module with all APIs.
+ *
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
+ * @see https://vueuse.org/useIpcRenderer
+ */
+declare function useIpcRenderer(ipcRenderer?: IpcRenderer): UseIpcRendererReturn;
+
+/**
+ * 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
+ */
+declare function useIpcRendererInvoke<T>(ipcRenderer: IpcRenderer, channel: string, ...args: any[]): Ref<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
+ */
+declare function useIpcRendererInvoke<T>(channel: string, ...args: any[]): Ref<T | null>;
+
+/**
+ * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
+ * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
+ *
+ * You need to provide `ipcRenderer` to this function.
+ *
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
+ * @see https://vueuse.org/useIpcRendererOn
+ */
+declare function useIpcRendererOn(ipcRenderer: IpcRenderer, channel: string, listener: IpcRendererListener): IpcRenderer;
+/**
+ * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
+ * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
+ *
+ * `ipcRenderer` will be automatically gotten.
+ *
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
+ * @see https://vueuse.org/useIpcRendererOn
+ */
+declare function useIpcRendererOn(channel: string, listener: IpcRendererListener): IpcRenderer;
+
+declare function useZoomFactor(factor: MaybeRef<number>): Ref<number>;
+declare function useZoomFactor(webFrame: WebFrame, factor: MaybeRef<number>): Ref<number>;
+declare function useZoomFactor(webFrame: WebFrame): Ref<number>;
+declare function useZoomFactor(): Ref<number>;
+
+declare function useZoomLevel(level: MaybeRef<number>): Ref<number>;
+declare function useZoomLevel(webFrame: WebFrame, level: MaybeRef<number>): Ref<number>;
+declare function useZoomLevel(webFrame: WebFrame): Ref<number>;
+declare function useZoomLevel(): Ref<number>;
+
+export { type UseIpcRendererReturn, useIpcRenderer, useIpcRendererInvoke, useIpcRendererOn, useZoomFactor, useZoomLevel };

package/index.d.mts

@@ -0,0 +1,140 @@
+import { IpcRendererEvent, IpcRenderer, WebFrame } from 'electron';
+import { Ref } from 'vue-demi';
+import { MaybeRef } from '@vueuse/shared';
+
+type IpcRendererListener = (event: IpcRendererEvent, ...args: any[]) => void;
+
+/**
+ * Result from useIpcRenderer
+ *
+ * @see https://www.electronjs.org/docs/api/ipc-renderer
+ */
+interface UseIpcRendererReturn {
+    /**
+     * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
+     * [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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    send(channel: string, ...args: any[]): void;
+    /**
+     * 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.
+     *
+     * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
+     */
+    invoke<T>(channel: string, ...args: any[]): Ref<T | null>;
+    /**
+     * Returns any - The value sent back by the ipcMain handler.
+     * 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
+     */
+    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
+     */
+    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
+     */
+    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
+     */
+    sendToHost(channel: string, ...args: any[]): void;
+}
+/**
+ * Get the `ipcRenderer` module with all APIs.
+ *
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
+ * @see https://vueuse.org/useIpcRenderer
+ */
+declare function useIpcRenderer(ipcRenderer?: IpcRenderer): UseIpcRendererReturn;
+
+/**
+ * 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
+ */
+declare function useIpcRendererInvoke<T>(ipcRenderer: IpcRenderer, channel: string, ...args: any[]): Ref<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
+ */
+declare function useIpcRendererInvoke<T>(channel: string, ...args: any[]): Ref<T | null>;
+
+/**
+ * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
+ * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
+ *
+ * You need to provide `ipcRenderer` to this function.
+ *
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
+ * @see https://vueuse.org/useIpcRendererOn
+ */
+declare function useIpcRendererOn(ipcRenderer: IpcRenderer, channel: string, listener: IpcRendererListener): IpcRenderer;
+/**
+ * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
+ * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
+ *
+ * `ipcRenderer` will be automatically gotten.
+ *
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
+ * @see https://vueuse.org/useIpcRendererOn
+ */
+declare function useIpcRendererOn(channel: string, listener: IpcRendererListener): IpcRenderer;
+
+declare function useZoomFactor(factor: MaybeRef<number>): Ref<number>;
+declare function useZoomFactor(webFrame: WebFrame, factor: MaybeRef<number>): Ref<number>;
+declare function useZoomFactor(webFrame: WebFrame): Ref<number>;
+declare function useZoomFactor(): Ref<number>;
+
+declare function useZoomLevel(level: MaybeRef<number>): Ref<number>;
+declare function useZoomLevel(webFrame: WebFrame, level: MaybeRef<number>): Ref<number>;
+declare function useZoomLevel(webFrame: WebFrame): Ref<number>;
+declare function useZoomLevel(): Ref<number>;
+
+export { type UseIpcRendererReturn, useIpcRenderer, useIpcRendererInvoke, useIpcRendererOn, useZoomFactor, useZoomLevel };

package/index.d.ts

@@ -137,4 +137,4 @@ declare function useZoomLevel(webFrame: WebFrame, level: MaybeRef<number>): Ref<
 declare function useZoomLevel(webFrame: WebFrame): Ref<number>;
 declare function useZoomLevel(): Ref<number>;
 
-export { UseIpcRendererReturn, useIpcRenderer, useIpcRendererInvoke, useIpcRendererOn, useZoomFactor, useZoomLevel };
+export { type UseIpcRendererReturn, useIpcRenderer, useIpcRendererInvoke, useIpcRendererOn, useZoomFactor, useZoomLevel };

package/index.mjs

@@ -47,7 +47,7 @@ function setSendSync(ipcRenderer) {
 }
 function useIpcRenderer(ipcRenderer) {
   if (!ipcRenderer)
-    ipcRenderer = window == null ? void 0 : window.require("electron").ipcRenderer;
+    ipcRenderer = window?.require("electron").ipcRenderer;
   if (!ipcRenderer)
     throw new Error("provide IpcRenderer module or enable nodeIntegration");
   return {
@@ -78,14 +78,14 @@ function useZoomFactor(...args) {
     throw new Error("provide WebFrame module or enable nodeIntegration");
   if (newFactor && newFactor.value === 0)
     throw new Error("the factor must be greater than 0.0.");
-  const factor = ref(newFactor != null ? newFactor : webFrame.getZoomFactor());
+  const factor = ref(newFactor ?? webFrame.getZoomFactor());
   watch(
     factor,
     (f, o) => {
       if (typeof f === "number" && f === 0)
         throw new Error("the factor must be greater than 0.0.");
       if (typeof f === "number" && f !== o)
-        webFrame == null ? void 0 : webFrame.setZoomFactor(f);
+        webFrame?.setZoomFactor(f);
     },
     { immediate: true }
   );
@@ -104,12 +104,12 @@ function useZoomLevel(...args) {
   }
   if (!webFrame)
     throw new Error("provide WebFrame module or enable nodeIntegration");
-  const level = ref(newLevel != null ? newLevel : webFrame.getZoomLevel());
+  const level = ref(newLevel ?? webFrame.getZoomLevel());
   watch(
     level,
     (f, o) => {
       if (typeof f === "number" && f !== o)
-        webFrame == null ? void 0 : webFrame.setZoomLevel(f);
+        webFrame?.setZoomLevel(f);
     },
     { immediate: true }
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vueuse/electron",
-  "version": "10.2.1",
+  "version": "10.4.0",
   "description": "Electron renderer process modules for VueUse",
   "author": "Archer Gu<https://github.com/ArcherGu>",
   "license": "MIT",
@@ -24,20 +24,19 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./index.d.ts",
-      "require": "./index.cjs",
-      "import": "./index.mjs"
+      "import": "./index.mjs",
+      "require": "./index.cjs"
     },
     "./*": "./*"
   },
   "main": "./index.cjs",
   "module": "./index.mjs",
-  "types": "./index.d.ts",
+  "types": "./index.d.cts",
   "peerDependencies": {
     "electron": ">=9.0.0"
   },
   "dependencies": {
-    "@vueuse/shared": "10.2.1",
+    "@vueuse/shared": "10.4.0",
     "vue-demi": ">=0.14.5"
   },
   "devDependencies": {