docs: event.newGuest for new-window in WebContents and webContents in BrowsweWindow's constructor (electron#21698)

weilonge · web-flow · commit 3e5486323ae5 · 2020-04-30T09:25:13.000-07:00
* docs: `newGuest` in `WebContents` and `webContents` in `BrowsweWindow`

According to the example codes in the documentation of `new-window`
event in `WebContents`, `webContents` in `BrowsweWindow` constructor
options and `newGuest` in `event` argument of `new-window` handler are
both existing but documented. This patch is for adding the related
documentations. Also, it provides typescript-definitations for these
two properties.

* Remove the documnent of `webContents` in BrowserWindow constructor option.
diff --git a/docs/api/structures/new-window-event.md b/docs/api/structures/new-window-event.md
@@ -0,0 +1,4 @@
+# NewWindowEvent Object extends `Event`
+
+* `newGuest` BrowserWindow (optional)
+
diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md
@@ -138,7 +138,7 @@ Emitted when page receives favicon urls.
 
 Returns:
 
-* `event` Event
+* `event` NewWindowEvent
 * `url` String
 * `frameName` String
 * `disposition` String - Can be `default`, `foreground-tab`, `background-tab`,
diff --git a/filenames.auto.gni b/filenames.auto.gni
@@ -100,6 +100,7 @@ auto_filenames = {
     "docs/api/structures/mime-typed-buffer.md",
     "docs/api/structures/mouse-input-event.md",
     "docs/api/structures/mouse-wheel-input-event.md",
+    "docs/api/structures/new-window-event.md",
     "docs/api/structures/notification-action.md",
     "docs/api/structures/point.md",
     "docs/api/structures/post-body.md",

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +# NewWindowEvent Object extends `Event`
++
 +* `newGuest` BrowserWindow (optional)
++