mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated documentation for power-monitor

Browse source 
Added two undocumented events, added note that must be used after ready event.
This commit is contained in:
Tom Moor 2015-04-14 21:03:58 -07:00
parent 29338e2fa4
commit 378e56e254
1 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/api/power-monitor.md
View file

@ -1,13 +1,19 @@
# power-monitor
The `power-monitor` module is used to monitor the power state change. You can
only use it on the main process.
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
require('power-monitor').on('suspend', function() {
console.log('The system is going to sleep');
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');
});
});
```
@ -18,3 +24,11 @@ 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.