fix: BrowserWindow.fromWebContents() can return null

electron · Aug 28, 2019 · 92e48d4 · 92e48d4
1 parent 27ce6a9
commit 92e48d4
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md
@@ -658,7 +658,8 @@ Returns `BrowserWindow | null` - The window that is focused in this application,
 
 * `webContents` [WebContents](web-contents.md)
 
-Returns `BrowserWindow` - The window that owns the given `webContents`.
+Returns `BrowserWindow | null` - The window that owns the given `webContents`
+or `null` if the contents are not owned by a window.
 
 #### `BrowserWindow.fromBrowserView(browserView)`
 

diff --git a/lib/browser/api/browser-window.js b/lib/browser/api/browser-window.js
@@ -118,6 +118,8 @@ BrowserWindow.fromWebContents = (webContents) => {
   for (const window of BrowserWindow.getAllWindows()) {
     if (window.webContents.equal(webContents)) return window
   }
+
+  return null
 }
 
 BrowserWindow.fromBrowserView = (browserView) => {

diff --git a/spec-main/api-browser-window-spec.ts b/spec-main/api-browser-window-spec.ts
@@ -1307,10 +1307,10 @@ describe('BrowserWindow module', () => {
       expect(found.id).to.equal(w.id)
     })
 
-    it('returns undefined for webContents without a BrowserWindow', () => {
+    it('returns null for webContents without a BrowserWindow', () => {
       const contents = (webContents as any).create({})
       try {
-        expect(BrowserWindow.fromWebContents(contents)).to.be.undefined('BrowserWindow.fromWebContents(contents)')
+        expect(BrowserWindow.fromWebContents(contents)).to.be.null('BrowserWindow.fromWebContents(contents)')
       } finally {
         contents.destroy()
       }