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

Standardize power-monitor

Browse source
This commit is contained in:
Jessica Lord 2015-08-28 21:37:07 -07:00
parent a38d34d368
commit 83aa9df1ee
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,10 +1,10 @@
# power-monitor # power-monitor
The `power-monitor` module is used to monitor the power state change. You can 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` only use it on the main process. You should not use this module until the `ready`
event of `app` module gets emitted. event of the `app` module is emitted.
An example is: For example:
```javascript ```javascript
var app = require('app'); var app = require('app');
@ -16,18 +16,22 @@ app.on('ready', function() {
}); });
``` ```
## Event: suspend ## Events
The `power-monitor` module emits the following events:
### Event: 'suspend'
Emitted when the system is suspending. Emitted when the system is suspending.
## Event: resume ### Event: 'resume'
Emitted when system is resuming. Emitted when system is resuming.
## Event: on-ac ### Event: 'on-ac'
Emitted when the system changes to AC power. Emitted when the system changes to AC power.
## Event: on-battery ### Event: 'on-battery'
Emitted when system changes to battery power. Emitted when system changes to battery power.