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 (#44651)

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

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

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

* fix: clear all listeners before running ipcMain removeAllListeners tests
This commit is contained in:
Will Anderson 2024-11-18 14:44:30 -08:00 • committed by GitHub
parent aa7a5e6ca9
commit 10d967028a
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

23
spec/api-ipc-main-spec.ts
View file

@ -92,4 +92,27 @@ describe('ipc main module', () => {
expect(v).to.equal('hello');
});
});
describe('ipcMain.removeAllListeners', () => {
beforeEach(() => { ipcMain.removeAllListeners(); });
beforeEach(() => { ipcMain.removeAllListeners(); });
it('removes only the given channel', () => {
ipcMain.on('channel1', () => {});
ipcMain.on('channel2', () => {});
ipcMain.removeAllListeners('channel1');
expect(ipcMain.eventNames()).to.deep.equal(['channel2']);
});
it('removes all channels if no channel is specified', () => {
ipcMain.on('channel1', () => {});
ipcMain.on('channel2', () => {});
ipcMain.removeAllListeners();
expect(ipcMain.eventNames()).to.deep.equal([]);
});
});
});