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

docs: add missing ipcRenderer.off() / ipcRenderer.addListener() aliases (#39816)

Browse source 
* docs: add missing `ipcRenderer.off()` / `ipcRenderer.addListener()` aliases

* Update docs/api/ipc-renderer.md

Co-authored-by: David Sanders <dsanders11@ucsbalum.com>

* fix ipcRenderer.removeListener

* update ts-smoke

---------

Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
This commit is contained in:
Milan Burda 2023-09-18 18:58:20 +02:00 • committed by GitHub
parent d7e4bb6608
commit 9c7086074e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 39 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

10
spec/ts-smoke/electron/main.ts
View file

@ -562,6 +562,11 @@ globalShortcut.unregisterAll();
// ipcMain
// https://github.com/electron/electron/blob/main/docs/api/ipc-main.md
ipcMain.handle('ping-pong', (event, arg: any) => {
console.log(arg); // prints "ping"
return 'pong';
});
ipcMain.on('asynchronous-message', (event, arg: any) => {
console.log(arg); // prints "ping"
event.sender.send('asynchronous-reply', 'pong');
@ -572,11 +577,6 @@ ipcMain.on('synchronous-message', (event, arg: any) => {
event.returnValue = 'pong';
});
ipcMain.on('synchronous-message', (event, arg: any) => {
console.log(arg); // prints "ping"
event.returnValue = 'pong';
});
const winWindows = new BrowserWindow({
width: 800,
height: 600,

12
spec/ts-smoke/electron/renderer.ts
View file

@ -4,8 +4,20 @@ import { clipboard, crashReporter, shell } from 'electron/common';
// In renderer process (web page).
// https://github.com/electron/electron/blob/main/docs/api/ipc-renderer.md
(async () => {
console.log(await ipcRenderer.invoke('ping-pong')); // prints "pong"
})();
console.log(ipcRenderer.sendSync('synchronous-message', 'ping')); // prints "pong"
ipcRenderer.on('test', () => {});
ipcRenderer.off('test', () => {});
ipcRenderer.once('test', () => {});
ipcRenderer.addListener('test', () => {});
ipcRenderer.removeListener('test', () => {});
ipcRenderer.removeAllListeners('test');
ipcRenderer.on('asynchronous-reply', (event, arg: any) => {
console.log(arg); // prints "pong"
event.sender.send('another-message', 'Hello World!');