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

fix: webContents return type incorrect (#38026)

Browse source 
* fix: webContents type incorrect

* fix: ci failed

* fix: ci failed 2
This commit is contained in:
Black-Hole️ 2023-04-24 22:28:21 +08:00 committed by GitHub
parent b626be5e33
commit 141f65b291
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/api/web-contents.md
View file

@ -65,28 +65,28 @@ for all windows, webviews, opened devtools, and devtools extension background pa
### `webContents.getFocusedWebContents()` ### `webContents.getFocusedWebContents()`
Returns `WebContents` | null - The web contents that is focused in this application, otherwise Returns `WebContents | null` - The web contents that is focused in this application, otherwise
returns `null`. returns `null`.
### `webContents.fromId(id)` ### `webContents.fromId(id)`
* `id` Integer * `id` Integer
Returns `WebContents` | undefined - A WebContents instance with the given ID, or Returns `WebContents | undefined` - A WebContents instance with the given ID, or
`undefined` if there is no WebContents associated with the given ID. `undefined` if there is no WebContents associated with the given ID.
### `webContents.fromFrame(frame)` ### `webContents.fromFrame(frame)`
* `frame` WebFrameMain * `frame` WebFrameMain
Returns `WebContents` | undefined - A WebContents instance with the given WebFrameMain, or Returns `WebContents | undefined` - A WebContents instance with the given WebFrameMain, or
`undefined` if there is no WebContents associated with the given WebFrameMain. `undefined` if there is no WebContents associated with the given WebFrameMain.
### `webContents.fromDevToolsTargetId(targetId)` ### `webContents.fromDevToolsTargetId(targetId)`
* `targetId` string - The Chrome DevTools Protocol [TargetID](https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID) associated with the WebContents instance. * `targetId` string - The Chrome DevTools Protocol [TargetID](https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID) associated with the WebContents instance.
Returns `WebContents` | undefined - A WebContents instance with the given TargetID, or Returns `WebContents | undefined` - A WebContents instance with the given TargetID, or
`undefined` if there is no WebContents associated with the given TargetID. `undefined` if there is no WebContents associated with the given TargetID.
When communicating with the [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/), When communicating with the [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/),

6
spec/api-web-contents-spec.ts
View file

@ -492,16 +492,16 @@ describe('webContents module', () => {
ifit(!(process.platform === 'win32' && process.arch === 'arm64'))('returns the focused web contents', async () => { ifit(!(process.platform === 'win32' && process.arch === 'arm64'))('returns the focused web contents', async () => {
const w = new BrowserWindow({ show: true }); const w = new BrowserWindow({ show: true });
await w.loadFile(path.join(__dirname, 'fixtures', 'blank.html')); await w.loadFile(path.join(__dirname, 'fixtures', 'blank.html'));
expect(webContents.getFocusedWebContents().id).to.equal(w.webContents.id); expect(webContents.getFocusedWebContents()?.id).to.equal(w.webContents.id);
const devToolsOpened = once(w.webContents, 'devtools-opened'); const devToolsOpened = once(w.webContents, 'devtools-opened');
w.webContents.openDevTools(); w.webContents.openDevTools();
await devToolsOpened; await devToolsOpened;
expect(webContents.getFocusedWebContents().id).to.equal(w.webContents.devToolsWebContents!.id); expect(webContents.getFocusedWebContents()?.id).to.equal(w.webContents.devToolsWebContents!.id);
const devToolsClosed = once(w.webContents, 'devtools-closed'); const devToolsClosed = once(w.webContents, 'devtools-closed');
w.webContents.closeDevTools(); w.webContents.closeDevTools();
await devToolsClosed; await devToolsClosed;
expect(webContents.getFocusedWebContents().id).to.equal(w.webContents.id); expect(webContents.getFocusedWebContents()?.id).to.equal(w.webContents.id);
}); });
it('does not crash when called on a detached dev tools window', async () => { it('does not crash when called on a detached dev tools window', async () => {

2
spec/chromium-spec.ts
View file

@ -1945,7 +1945,7 @@ describe('chromium features', () => {
await w1.loadFile(path.join(__dirname, 'fixtures', 'blank.html')); await w1.loadFile(path.join(__dirname, 'fixtures', 'blank.html'));
await w2.loadFile(path.join(__dirname, 'fixtures', 'blank.html')); await w2.loadFile(path.join(__dirname, 'fixtures', 'blank.html'));
await w3.loadFile(path.join(__dirname, 'fixtures', 'blank.html')); await w3.loadFile(path.join(__dirname, 'fixtures', 'blank.html'));
expect(webContents.getFocusedWebContents().id).to.equal(w2.webContents.id); expect(webContents.getFocusedWebContents()?.id).to.equal(w2.webContents.id);
let focus = false; let focus = false;
focus = await w1.webContents.executeJavaScript( focus = await w1.webContents.executeJavaScript(
'document.hasFocus()' 'document.hasFocus()'