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
|
2015-09-04 20:44:40 +00:00
|
|
|
only use it in the main process. You should not use this module until the `ready`
|
2015-08-29 04:37:07 +00:00
|
|
|
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
|
2015-04-15 04:03:58 +00:00
|
|
|
var app = require('app');
|
|
|
|
|
|
|
|
app.on('ready', function() {
|
2015-04-15 15:17:10 +00:00
|
|
|
require('power-monitor').on('suspend', function() {
|
2015-04-15 04:03:58 +00:00
|
|
|
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
|
|
|
|
2013-08-29 14:37:51 +00:00
|
|
|
Emitted when system is resuming.
|
2015-04-15 04:03:58 +00:00
|
|
|
|
2015-08-29 04:37:07 +00:00
|
|
|
### Event: 'on-ac'
|
2015-04-15 04:03:58 +00:00
|
|
|
|
|
|
|
Emitted when the system changes to AC power.
|
|
|
|
|
2015-08-29 04:37:07 +00:00
|
|
|
### Event: 'on-battery'
|
2015-04-15 04:03:58 +00:00
|
|
|
|
|
|
|
Emitted when system changes to battery power.
|