Synopsis

How to use Node.js and Electron APIs.

All of Node.js’s built-in modules are available in Electron and third-party node modules also fully supported as well (including the native modules).

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 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:

  1. const { app, BrowserWindow } = require('electron')
  2. let win = null
  4. app.whenReady().then(() => {
  5.   win = new BrowserWindow({ width: 800, height: 600 })
  6.   win.loadURL('https://github.com')
  7. })

The renderer process is no different than a normal web page, except for the extra ability to use node modules if nodeIntegration is enabled:

  1. <!DOCTYPE html>
  2. <html>
  3. <body>
  4. <script>
  5.   const fs = require('fs')
  6.   console.log(fs.readFileSync(__filename, 'utf8'))
  7. </script>
  8. </body>
  9. </html>

Destructuring assignment

As of 0.37, you can use destructuring assignment to make it easier to use built-in modules.

  1. const { app, BrowserWindow } = require('electron')
  3. let win
  5. app.whenReady().then(() => {
  6.   win = new BrowserWindow()
  7.   win.loadURL('https://github.com')
  8. })

If you need the entire electron module, you can require it and then using destructuring to access the individual modules from electron.

  1. const electron = require('electron')
  2. const { app, BrowserWindow } = electron
  4. let win
  6. app.whenReady().then(() => {
  7.   win = new BrowserWindow()
  8.   win.loadURL('https://github.com')
  9. })

This is equivalent to the following code:

  1. const electron = require('electron')
  2. const app = electron.app
  3. const BrowserWindow = electron.BrowserWindow
  4. let win
  6. app.whenReady().then(() => {
  7.   win = new BrowserWindow()
  8.   win.loadURL('https://github.com')
  9. })