@vueuse/electron 13.9.0 → 14.0.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.d.ts +149 -0
  2. package/dist/index.js +141 -0
  3. package/package.json +9 -11
  4. package/index.d.mts +0 -144
  5. package/index.mjs +0 -120
package/dist/index.d.ts ADDED
@@ -0,0 +1,149 @@
1
+ import { MaybeRef, Ref, ShallowRef } from "vue";
2
+ import { IpcRenderer, IpcRendererEvent, WebFrame } from "electron";
3
+
4
+ //#region _types.d.ts
5
+ type IpcRendererListener = (event: IpcRendererEvent, ...args: any[]) => void;
6
+ //#endregion
7
+ //#region useIpcRenderer/index.d.ts
8
+ /**
9
+ * Result from useIpcRenderer
10
+ *
11
+ * @see https://www.electronjs.org/docs/api/ipc-renderer
12
+ */
13
+ interface UseIpcRendererReturn {
14
+ /**
15
+ * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
16
+ * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
17
+ *
18
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
19
+ */
20
+ on: (channel: string, listener: IpcRendererListener) => IpcRenderer;
21
+ /**
22
+ * 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.
23
+ *
24
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereroncechannel-listener
25
+ */
26
+ once: (channel: string, listener: (event: IpcRendererEvent, ...args: any[]) => void) => IpcRenderer;
27
+ /**
28
+ * Removes the specified listener from the listener array for the specified channel.
29
+ *
30
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener
31
+ */
32
+ removeListener: (channel: string, listener: (...args: any[]) => void) => IpcRenderer;
33
+ /**
34
+ * Removes all listeners, or those of the specified channel.
35
+ *
36
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovealllistenerschannel
37
+ */
38
+ removeAllListeners: (channel: string) => IpcRenderer;
39
+ /**
40
+ * Send an asynchronous message to the main process via channel, along with arguments.
41
+ *
42
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendchannel-args
43
+ */
44
+ send: (channel: string, ...args: any[]) => void;
45
+ /**
46
+ * Returns Promise<any> - Resolves with the response from the main process.
47
+ * Send a message to the main process via channel and expect a result ~~asynchronously~~.
48
+ * As composition-api, it makes asynchronous operations look like synchronous.
49
+ *
50
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
51
+ */
52
+ invoke: <T>(channel: string, ...args: any[]) => ShallowRef<T | null>;
53
+ /**
54
+ * Returns any - The value sent back by the ipcMain handler.
55
+ * Send a message to the main process via channel and expect a result synchronously.
56
+ *
57
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendsyncchannel-args
58
+ */
59
+ sendSync: <T>(channel: string, ...args: any[]) => ShallowRef<T | null>;
60
+ /**
61
+ * Send a message to the main process, optionally transferring ownership of zero or more MessagePort objects.
62
+ *
63
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererpostmessagechannel-message-transfer
64
+ */
65
+ postMessage: (channel: string, message: any, transfer?: MessagePort[]) => void;
66
+ /**
67
+ * Sends a message to a window with webContentsId via channel.
68
+ *
69
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtowebcontentsid-channel-args
70
+ */
71
+ sendTo: (webContentsId: number, channel: string, ...args: any[]) => void;
72
+ /**
73
+ * Like ipcRenderer.send but the event will be sent to the <webview> element in the host page instead of the main process.
74
+ *
75
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
76
+ */
77
+ sendToHost: (channel: string, ...args: any[]) => void;
78
+ }
79
+ /**
80
+ * Get the `ipcRenderer` module with all APIs.
81
+ *
82
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
83
+ * @see https://vueuse.org/useIpcRenderer
84
+ */
85
+ declare function useIpcRenderer(ipcRenderer?: IpcRenderer): UseIpcRendererReturn;
86
+ //#endregion
87
+ //#region useIpcRendererInvoke/index.d.ts
88
+ /**
89
+ * Returns Promise<any> - Resolves with the response from the main process.
90
+ *
91
+ * Send a message to the main process via channel and expect a result ~~asynchronously~~. As composition-api, it makes asynchronous operations look like synchronous.
92
+ *
93
+ * You need to provide `ipcRenderer` to this function.
94
+ *
95
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
96
+ * @see https://vueuse.org/useIpcRendererInvoke
97
+ *
98
+ * @__NO_SIDE_EFFECTS__
99
+ */
100
+ declare function useIpcRendererInvoke<T>(ipcRenderer: IpcRenderer, channel: string, ...args: any[]): ShallowRef<T | null>;
101
+ /**
102
+ * Returns Promise<any> - Resolves with the response from the main process.
103
+ *
104
+ * Send a message to the main process via channel and expect a result ~~asynchronously~~. As composition-api, it makes asynchronous operations look like synchronous.
105
+ *
106
+ * `ipcRenderer` will be automatically gotten.
107
+ *
108
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
109
+ * @see https://vueuse.org/useIpcRendererInvoke
110
+ *
111
+ * @__NO_SIDE_EFFECTS__
112
+ */
113
+ declare function useIpcRendererInvoke<T>(channel: string, ...args: any[]): ShallowRef<T | null>;
114
+ //#endregion
115
+ //#region useIpcRendererOn/index.d.ts
116
+ /**
117
+ * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
118
+ * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
119
+ *
120
+ * You need to provide `ipcRenderer` to this function.
121
+ *
122
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
123
+ * @see https://vueuse.org/useIpcRendererOn
124
+ */
125
+ declare function useIpcRendererOn(ipcRenderer: IpcRenderer, channel: string, listener: IpcRendererListener): IpcRenderer;
126
+ /**
127
+ * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
128
+ * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
129
+ *
130
+ * `ipcRenderer` will be automatically gotten.
131
+ *
132
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
133
+ * @see https://vueuse.org/useIpcRendererOn
134
+ */
135
+ declare function useIpcRendererOn(channel: string, listener: IpcRendererListener): IpcRenderer;
136
+ //#endregion
137
+ //#region useZoomFactor/index.d.ts
138
+ declare function useZoomFactor(factor: MaybeRef<number>): Ref<number>;
139
+ declare function useZoomFactor(webFrame: WebFrame, factor: MaybeRef<number>): Ref<number>;
140
+ declare function useZoomFactor(webFrame: WebFrame): Ref<number>;
141
+ declare function useZoomFactor(): Ref<number>;
142
+ //#endregion
143
+ //#region useZoomLevel/index.d.ts
144
+ declare function useZoomLevel(level: MaybeRef<number>): Ref<number>;
145
+ declare function useZoomLevel(webFrame: WebFrame, level: MaybeRef<number>): Ref<number>;
146
+ declare function useZoomLevel(webFrame: WebFrame): Ref<number>;
147
+ declare function useZoomLevel(): Ref<number>;
148
+ //#endregion
149
+ export { UseIpcRendererReturn, useIpcRenderer, useIpcRendererInvoke, useIpcRendererOn, useZoomFactor, useZoomLevel };
package/dist/index.js ADDED
@@ -0,0 +1,141 @@
1
+ import { isRef, ref, shallowRef, watch } from "vue";
2
+ import { tryOnScopeDispose } from "@vueuse/shared";
3
+
4
+ //#region useIpcRendererInvoke/index.ts
5
+ /**
6
+ * Returns Promise<any> - Resolves with the response from the main process.
7
+ *
8
+ * Send a message to the main process via channel and expect a result ~~asynchronously~~. As composition-api, it makes asynchronous operations look like synchronous.
9
+ *
10
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
11
+ * @see https://vueuse.org/useIpcRendererInvoke
12
+ *
13
+ * @__NO_SIDE_EFFECTS__
14
+ */
15
+ function useIpcRendererInvoke(...args) {
16
+ let ipcRenderer;
17
+ let channel;
18
+ let invokeArgs;
19
+ if (typeof args[0] === "string") {
20
+ [channel, ...invokeArgs] = args;
21
+ ipcRenderer = window.require ? window.require("electron").ipcRenderer : void 0;
22
+ } else [ipcRenderer, channel, ...invokeArgs] = args;
23
+ if (!ipcRenderer) throw new Error("please provide IpcRenderer module or enable nodeIntegration");
24
+ const result = shallowRef(null);
25
+ ipcRenderer.invoke(channel, ...invokeArgs).then((response) => {
26
+ result.value = response;
27
+ });
28
+ return result;
29
+ }
30
+
31
+ //#endregion
32
+ //#region useIpcRendererOn/index.ts
33
+ function useIpcRendererOn(...args) {
34
+ let ipcRenderer;
35
+ let channel;
36
+ let listener;
37
+ if (typeof args[0] === "string") {
38
+ [channel, listener] = args;
39
+ ipcRenderer = window.require ? window.require("electron").ipcRenderer : void 0;
40
+ } else [ipcRenderer, channel, listener] = args;
41
+ if (!ipcRenderer) throw new Error("please provide IpcRenderer module or enable nodeIntegration");
42
+ tryOnScopeDispose(() => {
43
+ ipcRenderer.removeListener(channel, listener);
44
+ });
45
+ return ipcRenderer.on(channel, listener);
46
+ }
47
+
48
+ //#endregion
49
+ //#region useIpcRenderer/index.ts
50
+ /**
51
+ * Create a `sendSync` function
52
+ */
53
+ function setSendSync(ipcRenderer) {
54
+ return (channel, ...args) => {
55
+ const result = shallowRef(null);
56
+ result.value = ipcRenderer.sendSync(channel, ...args);
57
+ return result;
58
+ };
59
+ }
60
+ /**
61
+ * Get the `ipcRenderer` module with all APIs.
62
+ *
63
+ * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
64
+ * @see https://vueuse.org/useIpcRenderer
65
+ */
66
+ function useIpcRenderer(ipcRenderer) {
67
+ var _window;
68
+ if (!ipcRenderer) ipcRenderer = (_window = window) === null || _window === void 0 ? void 0 : _window.require("electron").ipcRenderer;
69
+ if (!ipcRenderer) throw new Error("provide IpcRenderer module or enable nodeIntegration");
70
+ return {
71
+ on: (channel, listener) => useIpcRendererOn(channel, listener),
72
+ once: ipcRenderer.once.bind(ipcRenderer),
73
+ removeListener: ipcRenderer.removeListener.bind(ipcRenderer),
74
+ removeAllListeners: ipcRenderer.removeAllListeners.bind(ipcRenderer),
75
+ send: ipcRenderer.send,
76
+ invoke: (channel, ...args) => useIpcRendererInvoke(ipcRenderer, channel, ...args),
77
+ sendSync: setSendSync(ipcRenderer),
78
+ postMessage: ipcRenderer.postMessage,
79
+ sendTo: ipcRenderer.sendTo,
80
+ sendToHost: ipcRenderer.sendToHost
81
+ };
82
+ }
83
+
84
+ //#endregion
85
+ //#region useZoomFactor/index.ts
86
+ /**
87
+ * Reactive WebFrame zoom factor
88
+ *
89
+ * @see https://www.electronjs.org/docs/api/web-frame#webframesetzoomfactorfactor
90
+ * @see https://vueuse.org/useZoomFactor
91
+ */
92
+ function useZoomFactor(...args) {
93
+ var _newFactor;
94
+ let webFrame;
95
+ let newFactor = null;
96
+ if (args.length === 0 || isRef(args[0]) && typeof args[0].value === "number" || typeof args[0] === "number") {
97
+ webFrame = window.require ? window.require("electron").webFrame : void 0;
98
+ newFactor = args.length > 0 ? ref(args[0]) : null;
99
+ } else {
100
+ webFrame = args[0];
101
+ newFactor = args.length > 1 ? ref(args[1]) : null;
102
+ }
103
+ if (!webFrame) throw new Error("provide WebFrame module or enable nodeIntegration");
104
+ if (newFactor && newFactor.value === 0) throw new Error("the factor must be greater than 0.0.");
105
+ const factor = ref((_newFactor = newFactor) !== null && _newFactor !== void 0 ? _newFactor : webFrame.getZoomFactor());
106
+ watch(factor, (f, o) => {
107
+ if (typeof f === "number" && f === 0) throw new Error("the factor must be greater than 0.0.");
108
+ if (typeof f === "number" && f !== o) webFrame === null || webFrame === void 0 || webFrame.setZoomFactor(f);
109
+ }, { immediate: true });
110
+ return factor;
111
+ }
112
+
113
+ //#endregion
114
+ //#region useZoomLevel/index.ts
115
+ /**
116
+ * Reactive WebFrame zoom level
117
+ *
118
+ * @see https://www.electronjs.org/docs/api/web-frame#webframesetzoomlevellevel
119
+ * @see https://vueuse.org/useZoomLevel
120
+ */
121
+ function useZoomLevel(...args) {
122
+ var _newLevel;
123
+ let webFrame;
124
+ let newLevel = null;
125
+ if (args.length === 0 || isRef(args[0]) && typeof args[0].value === "number" || typeof args[0] === "number") {
126
+ webFrame = window.require ? window.require("electron").webFrame : void 0;
127
+ newLevel = args.length > 0 ? ref(args[0]) : null;
128
+ } else {
129
+ webFrame = args[0];
130
+ newLevel = args.length > 1 ? ref(args[1]) : null;
131
+ }
132
+ if (!webFrame) throw new Error("provide WebFrame module or enable nodeIntegration");
133
+ const level = ref((_newLevel = newLevel) !== null && _newLevel !== void 0 ? _newLevel : webFrame.getZoomLevel());
134
+ watch(level, (f, o) => {
135
+ if (typeof f === "number" && f !== o) webFrame === null || webFrame === void 0 || webFrame.setZoomLevel(f);
136
+ }, { immediate: true });
137
+ return level;
138
+ }
139
+
140
+ //#endregion
141
+ export { useIpcRenderer, useIpcRendererInvoke, useIpcRendererOn, useZoomFactor, useZoomLevel };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@vueuse/electron",
3
3
  "type": "module",
4
- "version": "13.9.0",
4
+ "version": "14.0.0-alpha.1",
5
5
  "description": "Electron renderer process modules for VueUse",
6
6
  "author": "Archer Gu<https://github.com/ArcherGu>",
7
7
  "license": "MIT",
@@ -24,29 +24,27 @@
24
24
  ],
25
25
  "sideEffects": false,
26
26
  "exports": {
27
- ".": "./index.mjs",
28
- "./*": "./*"
27
+ ".": "./dist/index.js",
28
+ "./*": "./dist/*"
29
29
  },
30
- "main": "./index.mjs",
31
- "module": "./index.mjs",
32
- "types": "./index.d.mts",
30
+ "main": "./dist/index.js",
31
+ "module": "./dist/index.js",
32
+ "types": "./dist/index.d.ts",
33
33
  "files": [
34
- "*.d.mts",
35
- "*.js",
36
- "*.mjs"
34
+ "dist"
37
35
  ],
38
36
  "peerDependencies": {
39
37
  "electron": ">=9.0.0",
40
38
  "vue": "^3.5.0"
41
39
  },
42
40
  "dependencies": {
43
- "@vueuse/shared": "13.9.0"
41
+ "@vueuse/shared": "14.0.0-alpha.1"
44
42
  },
45
43
  "devDependencies": {
46
44
  "electron": "^13.1.0"
47
45
  },
48
46
  "scripts": {
49
- "build": "rollup --config=rollup.config.ts --configPlugin=rollup-plugin-esbuild",
47
+ "build": "tsdown",
50
48
  "test:attw": "attw --pack --config-path ../../.attw.json ."
51
49
  }
52
50
  }
package/index.d.mts DELETED
@@ -1,144 +0,0 @@
1
- import { IpcRendererEvent, IpcRenderer, WebFrame } from 'electron';
2
- import { ShallowRef, MaybeRef, Ref } from 'vue';
3
-
4
- type IpcRendererListener = (event: IpcRendererEvent, ...args: any[]) => void;
5
-
6
- /**
7
- * Result from useIpcRenderer
8
- *
9
- * @see https://www.electronjs.org/docs/api/ipc-renderer
10
- */
11
- interface UseIpcRendererReturn {
12
- /**
13
- * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
14
- * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
15
- *
16
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
17
- */
18
- on: (channel: string, listener: IpcRendererListener) => IpcRenderer;
19
- /**
20
- * 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.
21
- *
22
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereroncechannel-listener
23
- */
24
- once: (channel: string, listener: (event: IpcRendererEvent, ...args: any[]) => void) => IpcRenderer;
25
- /**
26
- * Removes the specified listener from the listener array for the specified channel.
27
- *
28
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener
29
- */
30
- removeListener: (channel: string, listener: (...args: any[]) => void) => IpcRenderer;
31
- /**
32
- * Removes all listeners, or those of the specified channel.
33
- *
34
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovealllistenerschannel
35
- */
36
- removeAllListeners: (channel: string) => IpcRenderer;
37
- /**
38
- * Send an asynchronous message to the main process via channel, along with arguments.
39
- *
40
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendchannel-args
41
- */
42
- send: (channel: string, ...args: any[]) => void;
43
- /**
44
- * Returns Promise<any> - Resolves with the response from the main process.
45
- * Send a message to the main process via channel and expect a result ~~asynchronously~~.
46
- * As composition-api, it makes asynchronous operations look like synchronous.
47
- *
48
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
49
- */
50
- invoke: <T>(channel: string, ...args: any[]) => ShallowRef<T | null>;
51
- /**
52
- * Returns any - The value sent back by the ipcMain handler.
53
- * Send a message to the main process via channel and expect a result synchronously.
54
- *
55
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendsyncchannel-args
56
- */
57
- sendSync: <T>(channel: string, ...args: any[]) => ShallowRef<T | null>;
58
- /**
59
- * Send a message to the main process, optionally transferring ownership of zero or more MessagePort objects.
60
- *
61
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererpostmessagechannel-message-transfer
62
- */
63
- postMessage: (channel: string, message: any, transfer?: MessagePort[]) => void;
64
- /**
65
- * Sends a message to a window with webContentsId via channel.
66
- *
67
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtowebcontentsid-channel-args
68
- */
69
- sendTo: (webContentsId: number, channel: string, ...args: any[]) => void;
70
- /**
71
- * Like ipcRenderer.send but the event will be sent to the <webview> element in the host page instead of the main process.
72
- *
73
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
74
- */
75
- sendToHost: (channel: string, ...args: any[]) => void;
76
- }
77
- /**
78
- * Get the `ipcRenderer` module with all APIs.
79
- *
80
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrenderersendtohostchannel-args
81
- * @see https://vueuse.org/useIpcRenderer
82
- */
83
- declare function useIpcRenderer(ipcRenderer?: IpcRenderer): UseIpcRendererReturn;
84
-
85
- /**
86
- * Returns Promise<any> - Resolves with the response from the main process.
87
- *
88
- * Send a message to the main process via channel and expect a result ~~asynchronously~~. As composition-api, it makes asynchronous operations look like synchronous.
89
- *
90
- * You need to provide `ipcRenderer` to this function.
91
- *
92
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
93
- * @see https://vueuse.org/useIpcRendererInvoke
94
- *
95
- * @__NO_SIDE_EFFECTS__
96
- */
97
- declare function useIpcRendererInvoke<T>(ipcRenderer: IpcRenderer, channel: string, ...args: any[]): ShallowRef<T | null>;
98
- /**
99
- * Returns Promise<any> - Resolves with the response from the main process.
100
- *
101
- * Send a message to the main process via channel and expect a result ~~asynchronously~~. As composition-api, it makes asynchronous operations look like synchronous.
102
- *
103
- * `ipcRenderer` will be automatically gotten.
104
- *
105
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args
106
- * @see https://vueuse.org/useIpcRendererInvoke
107
- *
108
- * @__NO_SIDE_EFFECTS__
109
- */
110
- declare function useIpcRendererInvoke<T>(channel: string, ...args: any[]): ShallowRef<T | null>;
111
-
112
- /**
113
- * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
114
- * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
115
- *
116
- * You need to provide `ipcRenderer` to this function.
117
- *
118
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
119
- * @see https://vueuse.org/useIpcRendererOn
120
- */
121
- declare function useIpcRendererOn(ipcRenderer: IpcRenderer, channel: string, listener: IpcRendererListener): IpcRenderer;
122
- /**
123
- * Listens to channel, when a new message arrives listener would be called with listener(event, args...).
124
- * [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted.
125
- *
126
- * `ipcRenderer` will be automatically gotten.
127
- *
128
- * @see https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener
129
- * @see https://vueuse.org/useIpcRendererOn
130
- */
131
- declare function useIpcRendererOn(channel: string, listener: IpcRendererListener): IpcRenderer;
132
-
133
- declare function useZoomFactor(factor: MaybeRef<number>): Ref<number>;
134
- declare function useZoomFactor(webFrame: WebFrame, factor: MaybeRef<number>): Ref<number>;
135
- declare function useZoomFactor(webFrame: WebFrame): Ref<number>;
136
- declare function useZoomFactor(): Ref<number>;
137
-
138
- declare function useZoomLevel(level: MaybeRef<number>): Ref<number>;
139
- declare function useZoomLevel(webFrame: WebFrame, level: MaybeRef<number>): Ref<number>;
140
- declare function useZoomLevel(webFrame: WebFrame): Ref<number>;
141
- declare function useZoomLevel(): Ref<number>;
142
-
143
- export { useIpcRenderer, useIpcRendererInvoke, useIpcRendererOn, useZoomFactor, useZoomLevel };
144
- export type { UseIpcRendererReturn };
package/index.mjs DELETED
@@ -1,120 +0,0 @@
1
- import { shallowRef, isRef, ref, watch } from 'vue';
2
- import { tryOnScopeDispose } from '@vueuse/shared';
3
-
4
- // @__NO_SIDE_EFFECTS__
5
- function useIpcRendererInvoke(...args) {
6
- let ipcRenderer;
7
- let channel;
8
- let invokeArgs;
9
- if (typeof args[0] === "string") {
10
- [channel, ...invokeArgs] = args;
11
- ipcRenderer = window.require ? window.require("electron").ipcRenderer : void 0;
12
- } else {
13
- [ipcRenderer, channel, ...invokeArgs] = args;
14
- }
15
- if (!ipcRenderer)
16
- throw new Error("please provide IpcRenderer module or enable nodeIntegration");
17
- const result = shallowRef(null);
18
- ipcRenderer.invoke(channel, ...invokeArgs).then((response) => {
19
- result.value = response;
20
- });
21
- return result;
22
- }
23
-
24
- function useIpcRendererOn(...args) {
25
- let ipcRenderer;
26
- let channel;
27
- let listener;
28
- if (typeof args[0] === "string") {
29
- [channel, listener] = args;
30
- ipcRenderer = window.require ? window.require("electron").ipcRenderer : void 0;
31
- } else {
32
- [ipcRenderer, channel, listener] = args;
33
- }
34
- if (!ipcRenderer)
35
- throw new Error("please provide IpcRenderer module or enable nodeIntegration");
36
- tryOnScopeDispose(() => {
37
- ipcRenderer.removeListener(channel, listener);
38
- });
39
- return ipcRenderer.on(channel, listener);
40
- }
41
-
42
- function setSendSync(ipcRenderer) {
43
- return (channel, ...args) => {
44
- const result = shallowRef(null);
45
- result.value = ipcRenderer.sendSync(channel, ...args);
46
- return result;
47
- };
48
- }
49
- function useIpcRenderer(ipcRenderer) {
50
- if (!ipcRenderer)
51
- ipcRenderer = window == null ? void 0 : window.require("electron").ipcRenderer;
52
- if (!ipcRenderer)
53
- throw new Error("provide IpcRenderer module or enable nodeIntegration");
54
- return {
55
- on: (channel, listener) => useIpcRendererOn(channel, listener),
56
- once: ipcRenderer.once.bind(ipcRenderer),
57
- removeListener: ipcRenderer.removeListener.bind(ipcRenderer),
58
- removeAllListeners: ipcRenderer.removeAllListeners.bind(ipcRenderer),
59
- send: ipcRenderer.send,
60
- invoke: (channel, ...args) => useIpcRendererInvoke(ipcRenderer, channel, ...args),
61
- sendSync: setSendSync(ipcRenderer),
62
- postMessage: ipcRenderer.postMessage,
63
- sendTo: ipcRenderer.sendTo,
64
- sendToHost: ipcRenderer.sendToHost
65
- };
66
- }
67
-
68
- function useZoomFactor(...args) {
69
- let webFrame;
70
- let newFactor = null;
71
- if (args.length === 0 || isRef(args[0]) && typeof args[0].value === "number" || typeof args[0] === "number") {
72
- webFrame = window.require ? window.require("electron").webFrame : void 0;
73
- newFactor = args.length > 0 ? ref(args[0]) : null;
74
- } else {
75
- webFrame = args[0];
76
- newFactor = args.length > 1 ? ref(args[1]) : null;
77
- }
78
- if (!webFrame)
79
- throw new Error("provide WebFrame module or enable nodeIntegration");
80
- if (newFactor && newFactor.value === 0)
81
- throw new Error("the factor must be greater than 0.0.");
82
- const factor = ref(newFactor != null ? newFactor : webFrame.getZoomFactor());
83
- watch(
84
- factor,
85
- (f, o) => {
86
- if (typeof f === "number" && f === 0)
87
- throw new Error("the factor must be greater than 0.0.");
88
- if (typeof f === "number" && f !== o)
89
- webFrame == null ? void 0 : webFrame.setZoomFactor(f);
90
- },
91
- { immediate: true }
92
- );
93
- return factor;
94
- }
95
-
96
- function useZoomLevel(...args) {
97
- let webFrame;
98
- let newLevel = null;
99
- if (args.length === 0 || isRef(args[0]) && typeof args[0].value === "number" || typeof args[0] === "number") {
100
- webFrame = window.require ? window.require("electron").webFrame : void 0;
101
- newLevel = args.length > 0 ? ref(args[0]) : null;
102
- } else {
103
- webFrame = args[0];
104
- newLevel = args.length > 1 ? ref(args[1]) : null;
105
- }
106
- if (!webFrame)
107
- throw new Error("provide WebFrame module or enable nodeIntegration");
108
- const level = ref(newLevel != null ? newLevel : webFrame.getZoomLevel());
109
- watch(
110
- level,
111
- (f, o) => {
112
- if (typeof f === "number" && f !== o)
113
- webFrame == null ? void 0 : webFrame.setZoomLevel(f);
114
- },
115
- { immediate: true }
116
- );
117
- return level;
118
- }
119
-
120
- export { useIpcRenderer, useIpcRendererInvoke, useIpcRendererOn, useZoomFactor, useZoomLevel };