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

📝 Rewrite docs on destructuring assignment [ci skip]

Browse source
This commit is contained in:
Steve Kinney 2016-05-04 11:59:40 -06:00
parent 5a9f28e034
commit afe0296e0f
1 changed files with 22 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
docs/api/synopsis.md
View file

@ -19,13 +19,11 @@ scripts to be able to use those modules.
The main process script is just like a normal Node.js script: The main process script is just like a normal Node.js script:
```javascript ```javascript
const electron = require('electron'); const { app, BrowserWindow } = require('electron');
const app = electron.app;
const BrowserWindow = electron.BrowserWindow;
var window = null; let window = null;
app.on('ready', function() { app.on('ready', () => {
window = new BrowserWindow({width: 800, height: 600}); window = new BrowserWindow({width: 800, height: 600});
window.loadURL('https://github.com'); window.loadURL('https://github.com');
}); });
@ -39,7 +37,7 @@ extra ability to use node modules:
<html> <html>
<body> <body>
<script> <script>
const remote = require('electron').remote; const { remote } = require('electron');
console.log(remote.app.getVersion()); console.log(remote.app.getVersion());
</script> </script>
</body> </body>
@ -50,16 +48,29 @@ To run your app, read [Run your app](../tutorial/quick-start.md#run-your-app).
## Destructuring assignment ## Destructuring assignment
If you are using CoffeeScript or Babel, you can also use As of 0.37, you can use
[destructuring assignment][destructuring-assignment] to make it easier to use [destructuring assignment][destructuring-assignment] to make it easier to use
built-in modules: built-in modules.
```javascript ```javascript
const {app, BrowserWindow} = require('electron') const { app, BrowserWindow } = require('electron');
``` ```
However if you are using plain JavaScript, you have to wait until Chrome fully If you need the entire `electron` module, you can require it and then using
supports ES6. destructuring to access the individual modules from `electron`.
```javascript
const electron = require('electron');
const { app, BrowserWindow } = electron;
```
This is equivalent to the following code:
```javascript
const electron = require('electron');
const app = electron.app;
const BrowserWindow = electron.BrowserWindow;
```
## Disable old styles of using built-in modules ## Disable old styles of using built-in modules