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

refactor: allow requiring modules with no side effects (#17496)

Browse source
This commit is contained in:
Shelley Vohr 2019-04-29 17:46:08 -07:00 • committed by Cheng Zhao
parent 4ee201c56e
commit 7b55ee9d36
10 changed files with 85 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/api/power-monitor.md
View file

@ -4,17 +4,17 @@
Process: [Main](../glossary.md#main-process)
You cannot require or use this module until the `ready` event of the `app`
This module cannot be used until the `ready` event of the `app`
module is emitted.
For example:
```javascript
const electron = require('electron')
const { app } = electron
const { app, powerMonitor } = require('electron')
app.on('ready', () => {
electron.powerMonitor.on('suspend', () => {
powerMonitor.on('suspend', () => {
console.log('The system is going to sleep')
})
})
@ -59,7 +59,7 @@ Emitted as soon as the systems screen is unlocked.
The `powerMonitor` module has the following methods:
#### `powerMonitor.querySystemIdleState(idleThreshold, callback)` _(Deprecated)_
### `powerMonitor.querySystemIdleState(idleThreshold, callback)` _(Deprecated)_
* `idleThreshold` Integer
* `callback` Function
@ -70,14 +70,14 @@ before considered idle. `callback` will be called synchronously on some systems
and with an `idleState` argument that describes the system's state. `locked` is
available on supported systems only.
#### `powerMonitor.querySystemIdleTime(callback)` _(Deprecated)_
### `powerMonitor.querySystemIdleTime(callback)` _(Deprecated)_
* `callback` Function
* `idleTime` Integer - Idle time in seconds
Calculate system idle time in seconds.
#### `powerMonitor.getSystemIdleState(idleThreshold)`
### `powerMonitor.getSystemIdleState(idleThreshold)`
* `idleThreshold` Integer
@ -86,9 +86,8 @@ Returns `String` - The system's current state. Can be `active`, `idle`, `locked`
Calculate the system idle state. `idleThreshold` is the amount of time (in seconds)
before considered idle. `locked` is available on supported systems only.
#### `powerMonitor.getSystemIdleTime()`
### `powerMonitor.getSystemIdleTime()`
Returns `Integer` - Idle time in seconds
Calculate system idle time in seconds.

13
docs/api/screen.md
View file

@ -4,7 +4,7 @@
Process: [Main](../glossary.md#main-process)
You cannot require or use this module until the `ready` event of the `app`
This module cannot be used until the `ready` event of the `app`
module is emitted.
`screen` is an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter).
@ -15,13 +15,11 @@ property, so writing `let { screen } = require('electron')` will not work.
An example of creating a window that fills the whole screen:
```javascript
const electron = require('electron')
const { app, BrowserWindow } = electron
const { app, BrowserWindow, screen } = require('electron')
let win
app.on('ready', () => {
const { width, height } = electron.screen.getPrimaryDisplay().workAreaSize
const { width, height } = screen.getPrimaryDisplay().workAreaSize
win = new BrowserWindow({ width, height })
win.loadURL('https://github.com')
})
@ -30,13 +28,12 @@ app.on('ready', () => {
Another example of creating a window in the external display:
```javascript
const electron = require('electron')
const { app, BrowserWindow } = require('electron')
const { app, BrowserWindow, screen } = require('electron')
let win
app.on('ready', () => {
let displays = electron.screen.getAllDisplays()
let displays = screen.getAllDisplays()
let externalDisplay = displays.find((display) => {
return display.bounds.x !== 0 || display.bounds.y !== 0
})