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

docs: webFrameMain.fromId() can return undefined (#27068)

Browse source 
* docs: webFrameMain.fromId() can return undefined

* docs: webFrameMain.fromId() can return undefined
This commit is contained in:
Milan Burda 2021-01-05 03:31:21 +01:00 committed by GitHub
parent c210956afb
commit 16c864a932
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/api/web-frame-main.md
View file

@ -63,7 +63,8 @@ These methods can be accessed from the `webFrameMain` module:
instances (`frame.routingId`) and are also passed by frame instances (`frame.routingId`) and are also passed by frame
specific `WebContents` navigation events (e.g. `did-frame-navigate`). specific `WebContents` navigation events (e.g. `did-frame-navigate`).
Returns `WebFrameMain` - A frame with the given process and routing IDs. Returns `WebFrameMain | undefined` - A frame with the given process and routing IDs,
or `undefined` if there is no WebFrameMain associated with the given IDs.
## Class: WebFrameMain ## Class: WebFrameMain

20
spec-main/api-web-frame-main-spec.ts
View file

@ -4,7 +4,7 @@ import * as path from 'path';
import * as url from 'url'; import * as url from 'url';
import { BrowserWindow, WebFrameMain, webFrameMain } from 'electron/main'; import { BrowserWindow, WebFrameMain, webFrameMain } from 'electron/main';
import { closeAllWindows } from './window-helpers'; import { closeAllWindows } from './window-helpers';
import { emittedOnce } from './events-helpers'; import { emittedOnce, emittedNTimes } from './events-helpers';
import { AddressInfo } from 'net'; import { AddressInfo } from 'net';
describe('webFrameMain module', () => { describe('webFrameMain module', () => {
@ -178,24 +178,24 @@ describe('webFrameMain module', () => {
}); });
}); });
it('webFrameMain.fromId can find each frame from navigation events', (done) => { describe('webFrameMain.fromId', () => {
it('returns undefined for unknown IDs', () => {
expect(webFrameMain.fromId(0, 0)).to.be.undefined();
});
it('can find each frame from navigation events', async () => {
const w = new BrowserWindow({ show: false, webPreferences: { contextIsolation: true } }); const w = new BrowserWindow({ show: false, webPreferences: { contextIsolation: true } });
// frame-with-frame-container.html, frame-with-frame.html, frame.html
const didFrameFinishLoad = emittedNTimes(w.webContents, 'did-frame-finish-load', 3);
w.loadFile(path.join(subframesPath, 'frame-with-frame-container.html')); w.loadFile(path.join(subframesPath, 'frame-with-frame-container.html'));
let eventCount = 0; for (const [, isMainFrame, frameProcessId, frameRoutingId] of await didFrameFinishLoad) {
w.webContents.on('did-frame-finish-load', (event, isMainFrame, frameProcessId, frameRoutingId) => {
const frame = webFrameMain.fromId(frameProcessId, frameRoutingId); const frame = webFrameMain.fromId(frameProcessId, frameRoutingId);
expect(frame).not.to.be.null(); expect(frame).not.to.be.null();
expect(frame?.processId).to.be.equal(frameProcessId); expect(frame?.processId).to.be.equal(frameProcessId);
expect(frame?.routingId).to.be.equal(frameRoutingId); expect(frame?.routingId).to.be.equal(frameRoutingId);
expect(frame?.top === frame).to.be.equal(isMainFrame); expect(frame?.top === frame).to.be.equal(isMainFrame);
eventCount++;
// frame-with-frame-container.html, frame-with-frame.html, frame.html
if (eventCount === 3) {
done();
} }
}); });
}); });