@delight-rpc/electron 6.0.2 → 6.0.4

package/README.md

@@ -7,14 +7,20 @@ yarn add @delight-rpc/electron
 ```
 
 ## Usage
+If your application sends RPC requests immediately after creating the RPC client,
+you need to create the RPC server as soon as possible,
+which means your corresponding code needs to be as **synchronized** as possible.
+
 ### Main as Client, Renderer as Server
+#### api.d.ts
 ```ts
-// api.d.ts
 interface IAPI {
   echo(message: string): string
 }
+```
 
-// main.js
+#### main.js
+```ts
 import { app, ipcMain } from 'electron'
 import { createClientInMain } from '@delight-rpc/electron'
 
@@ -32,8 +38,10 @@ const window = new BrowserWindow({
   webPreferences: { preload: 'preload.js' }
 })
 window.loadFile('renderer.html')
+```
 
-// preload.js
+#### preload.js
+```ts
 import { ipcRenderer } from 'electron'
 
 window.addEventListener('message', event => {
@@ -42,8 +50,10 @@ window.addEventListener('message', event => {
     ipcRenderer.postMessage('message-port', null, [port])
   }
 })
+```
 
-// renderer.js
+#### renderer.js
+```ts
 import { createServerInRenderer } from '@delight-rpc/electron'
 
 const api: IAPI = {
@@ -62,13 +72,15 @@ window.postMessage('message-port', '*', [channel.port2])
 ```
 
 ### Renderer as Client, Main as Server
+#### api.d.ts
 ```ts
-// api.d.ts
 interface IAPI {
   echo(message: string): string
 }
+```
 
-// main.js
+#### main.js
+```ts
 import { app, ipcMain } from 'electron'
 import { createClientInMain } from '@delight-rpc/electron'
 
@@ -80,7 +92,7 @@ const api: IAPI = {
 
 await app.whenReady()
 
-ipcMain.on('message-port', async event => {
+ipcMain.on('message-port', event => {
   const [port] = event.ports
 
   port.start()
@@ -91,8 +103,10 @@ const window = new BrowserWindow({
   webPreferences: { preload: 'preload.js' }
 })
 window.loadFile('renderer.html')
+```
 
-// preload.js
+#### preload.js
+```ts
 import { ipcRenderer } from 'electron'
 
 window.addEventListener('message', event => {
@@ -101,8 +115,10 @@ window.addEventListener('message', event => {
     ipcRenderer.postMessage('message-port', null, [port])
   }
 })
+```
 
-// renderer.js
+#### renderer.js
+```ts
 import { createClientInRenderer } from '@delight-rpc/electron'
 
 // create the MessageChannel in the renderer,
@@ -116,13 +132,15 @@ await client.echo('hello world')
 ```
 
 ### Renderer as Client, Renderer as Server
+#### api.d.ts
 ```ts
-// api.d.ts
 interface IAPI {
   echo(message: string): string
 }
+```
 
-// main.js
+#### main.js
+```ts
 import { app, ipcMain, MessageChannelMain } from 'electron'
 
 await app.whenReady()
@@ -140,8 +158,10 @@ windowB.loadFile('renderer-b.html')
 const channel = new MessageChannelMain()
 windowA.webContents.postMessage('message-port', null, [channel.port1])
 windowB.webContents.postMessage('message-port', null, [channel.port2])
+```
 
-// preload.ts
+#### preload.ts
+```ts
 import { ipcRenderer, contextBridge } from 'electron'
 import { Deferred } from 'extra-promise'
 
@@ -155,8 +175,10 @@ ipcRenderer.on('message-port', event => {
   await ready
   window.postMessage('message-port', '*', [port])
 })
+```
 
-// renderer-a.js
+#### renderer-a.js
+```ts
 import { createServerInRenderer } from '@delight-rpc/electron'
 
 const api: IAPI = {
@@ -175,8 +197,10 @@ window.addEventListener('message', async event => {
 })
 
 window.ready()
+```
 
-// renderer-b.js
+#### renderer-b.js
+```ts
 import { createClientInRenderer } from '@delight-rpc/electron'
 
 window.addEventListener('message', async event => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@delight-rpc/electron",
-  "version": "6.0.2",
+  "version": "6.0.4",
   "description": "",
   "keywords": [],
   "files": [
@@ -43,7 +43,7 @@
     "@typescript-eslint/parser": "^5.55.0",
     "cross-env": "^7.0.3",
     "delight-rpc": "^6.0.0",
-    "electron": "^16.0.7",
+    "electron": "^30.0.2",
     "eslint": "8.36.0",
     "husky": "4",
     "jest": "^29.5.0",
@@ -65,6 +65,6 @@
   },
   "peerDependencies": {
     "delight-rpc": "^5.0.0 || ^6.0.0",
-    "electron": "^16.0.1"
+    "electron": ">=16.0.1 <31"
   }
 }