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

Merge pull request #1421 from tommoor/patch-2

Browse source 
Updated documentation for power-monitor
This commit is contained in:
Cheng Zhao 2015-04-20 15:24:24 +08:00
commit 8f611687f1
1 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,13 +1,18 @@
# 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');
app.on('ready', function() {
require('power-monitor').on('suspend', function() {
console.log('The system is going to sleep');
});
});
```
@ -18,3 +23,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.