|
|
@@ -1,93 +0,0 @@
|
|
|
-# 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
|
|
|
-either process type.
|
|
|
-
|
|
|
-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
|
|
|
-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 if `nodeIntegration` is enabled:
|
|
|
-
|
|
|
-```html
|
|
|
-<!DOCTYPE html>
|
|
|
-<html>
|
|
|
-<body>
|
|
|
-<script>
|
|
|
- const fs = require('fs')
|
|
|
- console.log(fs.readFileSync(__filename, 'utf8'))
|
|
|
-</script>
|
|
|
-</body>
|
|
|
-</html>
|
|
|
-```
|
|
|
-
|
|
|
-## 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
|
Erick Zhao