c83f836faf
* docs: add references to app.whenReady() in isReady
* refactor: prefer app.whenReady()
In the docs, specs, and lib, replace instances of `app.once('ready')`
(seen occasionally) and `app.on('ready')` (extremely common) with
`app.whenReady()`.
It's better to encourage users to use whenReady():
1. it handles the edge case of registering for 'ready' after it's fired
2. it avoids the minor wart of leaving an active listener alive for
an event that wll never fire again
95 lines
2.5 KiB
Markdown
95 lines
2.5 KiB
Markdown
# Synopsis
|
|
|
|
> How to use Node.js and Electron APIs.
|
|
|
|
All of [Node.js's built-in modules](https://nodejs.org/api/) are available in
|
|
Electron and third-party node modules also fully supported as well (including
|
|
the [native modules](../tutorial/using-native-node-modules.md)).
|
|
|
|
Electron also provides some extra built-in modules for developing native
|
|
desktop applications. Some modules are only available in the main process, some
|
|
are only available in the renderer process (web page), and some can be used in
|
|
both processes.
|
|
|
|
The basic rule is: if a module is [GUI][gui] or low-level system related, then
|
|
it should be only available in the main process. You need to be familiar with
|
|
the concept of [main process vs. renderer process](../tutorial/application-architecture.md#main-and-renderer-processes)
|
|
scripts to be able to use those modules.
|
|
|
|
The main process script is like a normal Node.js script:
|
|
|
|
```javascript
|
|
const { app, BrowserWindow } = require('electron')
|
|
let win = null
|
|
|
|
app.whenReady().then(() => {
|
|
win = new BrowserWindow({ width: 800, height: 600 })
|
|
win.loadURL('https://github.com')
|
|
})
|
|
```
|
|
|
|
The renderer process is no different than a normal web page, except for the
|
|
extra ability to use node modules:
|
|
|
|
```html
|
|
<!DOCTYPE html>
|
|
<html>
|
|
<body>
|
|
<script>
|
|
const { app } = require('electron').remote
|
|
console.log(app.getVersion())
|
|
</script>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
To run your app, read [Run your app](../tutorial/first-app.md#running-your-app).
|
|
|
|
## Destructuring assignment
|
|
|
|
As of 0.37, you can use
|
|
[destructuring assignment][destructuring-assignment] to make it easier to use
|
|
built-in modules.
|
|
|
|
```javascript
|
|
const { app, BrowserWindow } = require('electron')
|
|
|
|
let win
|
|
|
|
app.whenReady().then(() => {
|
|
win = new BrowserWindow()
|
|
win.loadURL('https://github.com')
|
|
})
|
|
```
|
|
|
|
If you need the entire `electron` module, you can require it and then using
|
|
destructuring to access the individual modules from `electron`.
|
|
|
|
```javascript
|
|
const electron = require('electron')
|
|
const { app, BrowserWindow } = electron
|
|
|
|
let win
|
|
|
|
app.whenReady().then(() => {
|
|
win = new BrowserWindow()
|
|
win.loadURL('https://github.com')
|
|
})
|
|
```
|
|
|
|
This is equivalent to the following code:
|
|
|
|
```javascript
|
|
const electron = require('electron')
|
|
const app = electron.app
|
|
const BrowserWindow = electron.BrowserWindow
|
|
let win
|
|
|
|
app.whenReady().then(() => {
|
|
win = new BrowserWindow()
|
|
win.loadURL('https://github.com')
|
|
})
|
|
```
|
|
|
|
[gui]: https://en.wikipedia.org/wiki/Graphical_user_interface
|
|
[destructuring-assignment]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment
|