Browse Source

document the return value of ipcRenderer.sendSync

Zeke Sikelianos 7 years ago
parent
commit
f646be2981
1 changed files with 2 additions and 0 deletions
  1. 2 0
      docs/api/ipc-renderer.md

+ 2 - 0
docs/api/ipc-renderer.md

@@ -62,6 +62,8 @@ The main process handles it by listening for `channel` with `ipcMain` module.
 * `channel` String
 * `...args` any[]
 
+Returns `any` - The value sent back by the [`ipcMain`](ipc-main.md) handler.
+
 Send a message to the main process synchronously via `channel`, you can also
 send arbitrary arguments. Arguments will be serialized in JSON internally and
 hence no functions or prototype chain will be included.