electron/docs/api/power-monitor.md

38 lines
736 B
Markdown
Raw Normal View History

2013-09-09 07:35:57 +00:00
# power-monitor
2013-08-14 22:43:35 +00:00
2015-08-29 04:37:07 +00:00
The `power-monitor` module is used to monitor power state changes. You can
only use it on the main process. You should not 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
var app = require('app');
app.on('ready', function() {
2015-04-15 15:17:10 +00:00
require('power-monitor').on('suspend', function() {
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 `power-monitor` module emits the following events:
### 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.
2015-08-29 04:37:07 +00:00
### Event: 'on-ac'
Emitted when the system changes to AC power.
2015-08-29 04:37:07 +00:00
### Event: 'on-battery'
Emitted when system changes to battery power.