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

docs: Make ipcRenderer and ipcMain listener API docs consistent (#44711)

Browse source 
* docs: Make ipcRenderer and ipcMain listener API docs consistent

Co-authored-by: Will Anderson <will@itsananderson.com>

* test: add some unit tests for ipcRenderer/ipcMain listener behavior

Co-authored-by: Will Anderson <will@itsananderson.com>

* fix: Mark on/off methods as primary and addListener/removeListener as aliases

Co-authored-by: Will Anderson <will@itsananderson.com>

* fix: clear all listeners before running ipcMain removeAllListeners tests

Co-authored-by: Will Anderson <will@itsananderson.com>

---------

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: Will Anderson <will@itsananderson.com>
This commit is contained in:
trop[bot] 2024-11-19 09:47:45 +01:00 • committed by GitHub
commit 3764c4d0b3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 86 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

35
spec/api-ipc-renderer-spec.ts
View file

@ -18,6 +18,7 @@ describe('ipcRenderer module', () => {
}
});
await w.loadURL('about:blank');
w.webContents.on('console-message', (event, ...args) => console.error(...args));
});
after(async () => {
await closeWindow(w);
@ -144,6 +145,40 @@ describe('ipcRenderer module', () => {
});
});
describe('ipcRenderer.removeAllListeners', () => {
it('removes only the given channel', async () => {
const result = await w.webContents.executeJavaScript(`
(() => {
const { ipcRenderer } = require('electron');
ipcRenderer.on('channel1', () => {});
ipcRenderer.on('channel2', () => {});
ipcRenderer.removeAllListeners('channel1');
return ipcRenderer.eventNames();
})()
`);
expect(result).to.deep.equal(['channel2']);
});
it('removes all channels if no channel is specified', async () => {
const result = await w.webContents.executeJavaScript(`
(() => {
const { ipcRenderer } = require('electron');
ipcRenderer.on('channel1', () => {});
ipcRenderer.on('channel2', () => {});
ipcRenderer.removeAllListeners();
return ipcRenderer.eventNames();
})()
`);
expect(result).to.deep.equal([]);
});
});
describe('after context is released', () => {
it('throws an exception', async () => {
const error = await w.webContents.executeJavaScript(`(${() => {