electron/docs/api/power-monitor.md

40 lines
703 B
Markdown
Raw Normal View History

# powerMonitor
2013-08-14 22:43:35 +00:00
2016-04-21 22:39:12 +00:00
> Monitor power state changes.
You cannot require or use this module until the `ready` event of the `app`
module is emitted.
2013-08-14 22:43:35 +00:00
2015-08-29 04:37:07 +00:00
For example:
2013-08-14 22:43:35 +00:00
```javascript
const electron = require('electron')
const {app} = electron
app.on('ready', () => {
electron.powerMonitor.on('suspend', () => {
console.log('The system is going to sleep')
})
})
2013-08-14 22:43:35 +00:00
```
2015-08-29 04:37:07 +00:00
## Events
The `powerMonitor` module emits the following events:
2015-08-29 04:37:07 +00:00
### Event: 'suspend'
2013-08-14 22:43:35 +00:00
Emitted when the system is suspending.
2015-08-29 04:37:07 +00:00
### Event: 'resume'
2013-08-14 22:43:35 +00:00
Emitted when system is resuming.
### Event: 'on-ac' _Windows_
Emitted when the system changes to AC power.
### Event: 'on-battery' _Windows_
Emitted when system changes to battery power.