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

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
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 19 deletions
Show stats 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 * `channel` string
* `listener` Function<Promise\<void&#62; | any&#62; * `listener` Function<Promise\<void&#62; | any&#62;
* `event` IpcMainInvokeEvent * `event` [IpcMainInvokeEvent][ipc-main-invoke-event]
* `...args` any[] * `...args` any[]
Handles a single `invoke`able IPC message, then removes the listener. See 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. 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 [IPC tutorial]: ../tutorial/ipc.md
[event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter [event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter
[web-contents-send]: ../api/web-contents.md#contentssendchannel-args [web-contents-send]: ../api/web-contents.md#contentssendchannel-args

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

@ -26,7 +26,7 @@ The `ipcRenderer` module has the following method to listen for events and send
* `channel` string * `channel` string
* `listener` Function * `listener` Function
* `event` IpcRendererEvent * `event` [IpcRendererEvent][ipc-renderer-event]
* `...args` any[] * `...args` any[]
Listens to `channel`, when a new message arrives `listener` would be called with Listens to `channel`, when a new message arrives `listener` would be called with
@ -36,7 +36,7 @@ Listens to `channel`, when a new message arrives `listener` would be called with
* `channel` string * `channel` string
* `listener` Function * `listener` Function
* `event` IpcRendererEvent * `event` [IpcRendererEvent][ipc-renderer-event]
* `...args` any[] * `...args` any[]
Adds a one time `listener` function for the event. This `listener` is invoked Adds a one time `listener` function for the event. This `listener` is invoked
@ -208,12 +208,8 @@ Sends a message to a window with `webContentsId` via `channel`.
Like `ipcRenderer.send` but the event will be sent to the `<webview>` element in Like `ipcRenderer.send` but the event will be sent to the `<webview>` element in
the host page instead of the main process. the host page instead of the main process.
## Event object
The documentation for the `event` object passed to the `callback` can be found
in the [`ipc-renderer-event`](./structures/ipc-renderer-event.md) structure docs.
[event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter [event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter
[SCA]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm [SCA]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
[`window.postMessage`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage [`window.postMessage`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage
[`MessagePort`]: https://developer.mozilla.org/en-US/docs/Web/API/MessagePort [`MessagePort`]: https://developer.mozilla.org/en-US/docs/Web/API/MessagePort
[ipc-renderer-event]: ./structures/ipc-renderer-event.md