docs: delete synopsis.md (#37580)
* docs: delete synopsis.md * remove code references to doc
This commit is contained in:
Erick Zhao
GitHub
parent
b8f970c1c7
commit
095f9067a7
4 changed files with 0 additions and 98 deletions
|
|
@ -90,7 +90,6 @@ These individual tutorials expand on topics discussed in the guide above.
|
||||||
|
|
||||||
## API References
|
## API References
|
||||||
|
|
||||||
* [Synopsis](api/synopsis.md)
|
|
||||||
* [Process Object](api/process.md)
|
* [Process Object](api/process.md)
|
||||||
* [Supported Command Line Switches](api/command-line-switches.md)
|
* [Supported Command Line Switches](api/command-line-switches.md)
|
||||||
* [Environment Variables](api/environment-variables.md)
|
* [Environment Variables](api/environment-variables.md)
|
||||||
|
|
|
||||||
|
|
@ -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
|
|
||||||
|
|
@ -49,7 +49,6 @@ auto_filenames = {
|
||||||
"docs/api/share-menu.md",
|
"docs/api/share-menu.md",
|
||||||
"docs/api/shell.md",
|
"docs/api/shell.md",
|
||||||
"docs/api/structures",
|
"docs/api/structures",
|
||||||
"docs/api/synopsis.md",
|
|
||||||
"docs/api/system-preferences.md",
|
"docs/api/system-preferences.md",
|
||||||
"docs/api/touch-bar-button.md",
|
"docs/api/touch-bar-button.md",
|
||||||
"docs/api/touch-bar-color-picker.md",
|
"docs/api/touch-bar-color-picker.md",
|
||||||
|
|
|
||||||
|
|
@ -331,9 +331,6 @@ ipcMain.on('online-status-changed', (event, status: any) => {
|
||||||
console.log(status);
|
console.log(status);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Synopsis
|
|
||||||
// https://github.com/electron/electron/blob/main/docs/api/synopsis.md
|
|
||||||
|
|
||||||
app.whenReady().then(() => {
|
app.whenReady().then(() => {
|
||||||
window = new BrowserWindow({
|
window = new BrowserWindow({
|
||||||
width: 800,
|
width: 800,
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue