electron/docs/api/power-monitor.md
Tom Moor 378e56e254 Updated documentation for power-monitor
Added two undocumented events, added note that must be used after ready event.
2015-04-14 21:03:58 -07:00

34 lines
694 B
Markdown

# power-monitor
The `power-monitor` module is used to monitor the power state change. You can
only use it on the main process. You should not use this module until the `ready`
event of `app` module gets emitted.
An example is:
```javascript
var app = require('app');
var powerMonitor = require('power-monitor');
app.on('ready', function() {
powerMonitor.on('suspend', function() {
console.log('The system is going to sleep');
});
});
```
## Event: suspend
Emitted when the system is suspending.
## Event: resume
Emitted when system is resuming.
## Event: on-ac
Emitted when the system changes to AC power.
## Event: on-battery
Emitted when system changes to battery power.