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

Document the return values of all methods in the docs

Browse source
This commit is contained in:
Samuel Attard 2016-09-25 12:59:30 +13:00 • committed by Samuel Attard
parent bf88fe32fd
commit d2a701a465
22 changed files with 276 additions and 175 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/api/remote.md
View file

@ -138,22 +138,22 @@ The `remote` module has the following methods:
* `module` String
Returns the object returned by `require(module)` in the main process.
Returns `Object` - The object returned by `require(module)` in the main process.
### `remote.getCurrentWindow()`
Returns the [`BrowserWindow`](browser-window.md) object to which this web page
Returns `BrowserWindow` - The [`BrowserWindow`](browser-window.md) object to which this web page
belongs.
### `remote.getCurrentWebContents()`
Returns the [`WebContents`](web-contents.md) object of this web page.
Returns `WebContents` - The [`WebContents`](web-contents.md) object of this web page.
### `remote.getGlobal(name)`
* `name` String
Returns the global variable of `name` (e.g. `global[name]`) in the main
Returns `any` - The global variable of `name` (e.g. `global[name]`) in the main
process.
## Properties