electron/docs/api/power-monitor.md
Alejandro Gonzalez Sole ab685ac335 Update power-monitor.md
Updated docs in power-monitor to reflect windows only events
2016-03-27 23:03:34 -04:00

35 lines
736 B
Markdown

# powerMonitor
The `power-monitor` module is used to monitor power state changes. You can
only use it in the main process. You should not use this module until the `ready`
event of the `app` module is emitted.
For example:
```javascript
app.on('ready', function() {
require('electron').powerMonitor.on('suspend', function() {
console.log('The system is going to sleep');
});
});
```
## Events
The `power-monitor` module emits the following events:
### Event: 'suspend'
Emitted when the system is suspending.
### Event: 'resume'
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.