mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: ensure that optionality matches between documented params and signatures (#18613)

Browse source 
* docs: ensure that optionality matches between documented params and signatures

* docs: ensure that all optional declarations are lower case

* chore: fix broken link
This commit is contained in:
Samuel Attard 2019-06-04 14:03:24 -07:00 • committed by GitHub
parent 69e32ad9ce
commit f80601da16
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 127 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/api/ipc-renderer.md
View file

@ -51,7 +51,7 @@ Removes the specified `listener` from the listener array for the specified
Removes all listeners, or those of the specified `channel`.
### `ipcRenderer.send(channel[, arg1][, arg2][, ...])`
### `ipcRenderer.send(channel, ...args)`
* `channel` String
* `...args` any[]
@ -63,7 +63,7 @@ hence no functions or prototype chain will be included.
The main process handles it by listening for `channel` with the
[`ipcMain`](ipc-main.md) module.
### `ipcRenderer.invoke(channel[, arg1][, arg2][, ...])`
### `ipcRenderer.invoke(channel, ...args)`
* `channel` String
* `...args` any[]
@ -91,7 +91,7 @@ ipcMain.handle('some-name', async (event, someArgument) => {
})
```
### `ipcRenderer.sendSync(channel[, arg1][, arg2][, ...])`
### `ipcRenderer.sendSync(channel, ...args)`
* `channel` String
* `...args` any[]
@ -108,7 +108,7 @@ and replies by setting `event.returnValue`.
**Note:** Sending a synchronous message will block the whole renderer process,
unless you know what you are doing you should never use it.
### `ipcRenderer.sendTo(webContentsId, channel, [, arg1][, arg2][, ...])`
### `ipcRenderer.sendTo(webContentsId, channel, ...args)`
* `webContentsId` Number
* `channel` String
@ -116,7 +116,7 @@ unless you know what you are doing you should never use it.
Sends a message to a window with `webContentsId` via `channel`.
### `ipcRenderer.sendToHost(channel[, arg1][, arg2][, ...])`
### `ipcRenderer.sendToHost(channel, ...args)`
* `channel` String
* `...args` any[]