github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-01-09 15:38:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove redundant IPC event sections (#39133)

Browse Source 
* docs: use correct names for IPC events

* docs: remove redundant IPC event sections
This commit is contained in:
David Sanders
2023-07-20 11:43:08 -07:00
committed by GitHub
parent 6688b0f31a
commit 3a5e2dd90c
2 changed files with 4 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/api/ipc-main.md
View File

@@ -110,7 +110,7 @@ provided to the renderer process. Please refer to
* `channel` string
* `listener` Function<Promise\<void&#62; | any&#62;
* `event` IpcMainInvokeEvent
* `event` [IpcMainInvokeEvent][ipc-main-invoke-event]
* `...args` any[]
Handles a single `invoke`able IPC message, then removes the listener. See
@@ -122,17 +122,6 @@ Handles a single `invoke`able IPC message, then removes the listener. See
Removes any handler for `channel`, if present.
## IpcMainEvent object
The documentation for the `event` object passed to the `callback` can be found
in the [`ipc-main-event`][ipc-main-event] structure docs.
## IpcMainInvokeEvent object
The documentation for the `event` object passed to `handle` callbacks can be
found in the [`ipc-main-invoke-event`][ipc-main-invoke-event]
structure docs.
[IPC tutorial]: ../tutorial/ipc.md
[event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter
[web-contents-send]: ../api/web-contents.md#contentssendchannel-args