Merge pull request #1883 from atom/http-referer-doc

📝 Add missing `httpreferer` option doc.
This commit is contained in:
Cheng Zhao 2015-06-09 11:15:44 +08:00
commit 24586c1330
4 changed files with 12 additions and 9 deletions

View file

@ -571,9 +571,9 @@ Calling `window.print()` in web page is equivalent to call
doesn't need print feature, you can safely remove `pdf.dll` in saving binary
size.
### BrowserWindow.loadUrl(url)
### BrowserWindow.loadUrl(url, [options])
Same with `webContents.loadUrl(url)`.
Same with `webContents.loadUrl(url, [options])`.
### BrowserWindow.reload()
@ -778,9 +778,12 @@ Emitted when a plugin process is crashed.
Emitted when the WebContents is destroyed.
### WebContents.loadUrl(url)
### WebContents.loadUrl(url, [options])
* `url` URL
* `options` URL
* `httpReferrer` String - A HTTP Referer url
* `userAgent` String - A user agent originating the request
Loads the `url` in the window, the `url` must contains the protocol prefix,
e.g. the `http://` or `file://`.