review comments and some yarn 💩

electron · May 29, 2019 · 2d40e8a · 2d40e8a
1 parent 8f25f91
commit 2d40e8a
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 32 deletions.
diff --git a/docs/api/ipc-main.md b/docs/api/ipc-main.md
@@ -91,7 +91,7 @@ Removes listeners of the specified `channel`.
 ### `ipcMain.handle(channel, listener)`
 
 * `channel` String
-* `listener` Function
+* `listener` Function<Promise> | Function<any>
   * `event` IpcMainEvent
   * `...args` any[]
 
@@ -103,13 +103,13 @@ returned as a reply to the remote caller. Otherwise, the return value of the
 listener will be used as the value of the reply.
 
 ```js
-// main process
+// Main process
 ipcMain.handle('my-invokable-ipc', async (event, ...args) => {
   const result = await somePromise(...args)
   return result
 })
 
-// renderer process
+// Renderer process
 async () => {
   const result = await ipcRenderer.invoke('my-invokable-ipc', arg1, arg2)
   // ...
@@ -123,7 +123,7 @@ WebContents is the source of the invoke request.
 ### `ipcMain.handleOnce(channel, listener)`
 
 * `channel` String
-* `listener` Function
+* `listener` Function<Promise> | Function<any>
   * `event` IpcMainEvent
   * `...args` any[]
 

diff --git a/docs/api/ipc-renderer.md b/docs/api/ipc-renderer.md
@@ -60,7 +60,8 @@ Send a message to the main process asynchronously via `channel`, you can also
 send arbitrary arguments. Arguments will be serialized as JSON internally and
 hence no functions or prototype chain will be included.
 
-The main process handles it by listening for `channel` with [`ipcMain`](ipc-main.md) module.
+The main process handles it by listening for `channel` with the
+[`ipcMain`](ipc-main.md) module.
 
 ### `ipcRenderer.invoke(channel[, arg1][, arg2][, ...])`
 
@@ -73,22 +74,20 @@ Send a message to the main process asynchronously via `channel` and expect an
 asynchronous result. Arguments will be serialized as JSON internally and
 hence no functions or prototype chain will be included.
 
-The main process should listen for `channel` with the [`ipcMain`](ipc-main.md)
-module, and send a result by calling `event.reply()`.
+The main process should listen for `channel` with
+[`ipcMain.handle()`](ipc-main.md#ipcmainhandlechannel-listener).
 
 For example:
 ```javascript
-// Renderer
+// Renderer process
 ipcRenderer.invoke('some-name', someArgument).then((result) => {
   // ...
 })
 
-// Main
-ipcMain.on('some-name', (event, someArgument) => {
-  doSomeWork().then(() => {
-    // ...
-    event.reply(someResult)
-  })
+// Main process
+ipcMain.handle('some-name', async (event, someArgument) => {
+  const result = await doSomeWork(someArgument)
+  return result
 })
 ```
 

diff --git a/lib/browser/api/ipc-main.ts b/lib/browser/api/ipc-main.ts
@@ -2,26 +2,22 @@ import { EventEmitter } from 'events'
 import { IpcMainEvent } from 'electron'
 
 class IpcMain extends EventEmitter {
-  _invokeHandlers: {[channel: string]: (e: IpcMainEvent, ...args: any[]) => void};
-  constructor () {
-    super()
-    this._invokeHandlers = {}
-  }
+  private _invokeHandlers: Map<string, (e: IpcMainEvent, ...args: any[]) => void> = new Map();
 
   handle (method: string, fn: (e: IpcMainEvent, ...args: any[]) => any) {
-    if (method in this._invokeHandlers) {
+    if (this._invokeHandlers.has(method)) {
       throw new Error(`Attempted to register a second handler for '${method}'`)
     }
     if (typeof fn !== 'function') {
       throw new Error(`Expected handler to be a function, but found type '${typeof fn}'`)
     }
-    this._invokeHandlers[method] = async (e, ...args) => {
+    this._invokeHandlers.set(method, async (e, ...args) => {
       try {
         (e as any).reply(await Promise.resolve(fn(e, ...args)))
       } catch (err) {
         (e as any).throw(err)
       }
-    }
+    })
   }
 
   handleOnce (method: string, fn: Function) {
@@ -32,7 +28,7 @@ class IpcMain extends EventEmitter {
   }
 
   removeHandler (method: string) {
-    delete this._invokeHandlers[method]
+    this._invokeHandlers.delete(method)
   }
 }
 

diff --git a/lib/browser/api/web-contents.js b/lib/browser/api/web-contents.js
@@ -330,8 +330,8 @@ WebContents.prototype._init = function () {
     event.reply = (result) => event.sendReply({ result })
     event.throw = (error) => event.sendReply({ error: error.toString() })
     this.emit('ipc-invoke', event, channel, ...args)
-    if (channel in ipcMain._invokeHandlers) {
-      ipcMain._invokeHandlers[channel](event, ...args)
+    if (ipcMain._invokeHandlers.has(channel)) {
+      ipcMain._invokeHandlers.get(channel)(event, ...args)
     } else {
       event.throw(`No handler registered for '${channel}'`)
     }

diff --git a/package.json b/package.json
@@ -136,4 +136,4 @@
       "git add filenames.auto.gni"
     ]
   }
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -136,4 +136,4 @@ @@
           "git add filenames.auto.gni"
         ]
       }
-    }
+    }