|
@@ -1,9 +1,10 @@
|
|
|
-# power-save-blocker
|
|
|
+# powerSaveBlocker
|
|
|
|
|
|
The `power-save-blocker` module is used to block the system from entering
|
|
|
-low-power(sleep) mode, allowing app to keep system and screen active.
|
|
|
+low-power (sleep) mode thus allowing the app to keep the system and screen
|
|
|
+active.
|
|
|
|
|
|
-An example is:
|
|
|
+For example:
|
|
|
|
|
|
```javascript
|
|
|
var powerSaveBlocker = require('power-save-blocker');
|
|
@@ -14,35 +15,40 @@ console.log(powerSaveBlocker.isStarted(id));
|
|
|
powerSaveBlocker.stop(id);
|
|
|
```
|
|
|
|
|
|
-## powerSaveBlocker.start(type)
|
|
|
+## Methods
|
|
|
|
|
|
-* `type` String - Power save blocker type
|
|
|
+The `powerSaveBlocker` module has the following methods:
|
|
|
+
|
|
|
+### `powerSaveBlocker.start(type)`
|
|
|
+
|
|
|
+* `type` String - Power save blocker type.
|
|
|
* `prevent-app-suspension` - Prevent the application from being suspended.
|
|
|
- Keeps system active, but allows screen to be turned off. Example use cases:
|
|
|
- downloading a file, playing audio.
|
|
|
- * `prevent-display-sleep`- Prevent the display from going to sleep. Keeps system
|
|
|
- and screen active. Example use case: playing video.
|
|
|
+ Keeps system active but allows screen to be turned off. Example use cases:
|
|
|
+ downloading a file or playing audio.
|
|
|
+ * `prevent-display-sleep`- Prevent the display from going to sleep. Keeps
|
|
|
+ system and screen active. Example use case: playing video.
|
|
|
|
|
|
-Starts the power save blocker preventing the system entering lower-power mode.
|
|
|
-Returns an integer identified the power save blocker.
|
|
|
+Starts the power save blocker preventing the system from entering lower-power
|
|
|
+mode. Returns an integer identifying the power save blocker.
|
|
|
|
|
|
-**Note:**
|
|
|
-`prevent-display-sleep` has higher precedence level than `prevent-app-suspension`.
|
|
|
-Only the highest precedence type takes effect. In other words, `prevent-display-sleep`
|
|
|
-always take precedence over `prevent-app-suspension`.
|
|
|
+**Note:** `prevent-display-sleep` has higher has precedence over
|
|
|
+`prevent-app-suspension`. Only the highest precedence type takes effect. In
|
|
|
+other words, `prevent-display-sleep` always take precedence over
|
|
|
+`prevent-app-suspension`.
|
|
|
|
|
|
For example, an API calling A requests for `prevent-app-suspension`, and
|
|
|
another calling B requests for `prevent-display-sleep`. `prevent-display-sleep`
|
|
|
-will be used until B stops its request. After that, `prevent-app-suspension` is used.
|
|
|
+will be used until B stops its request. After that, `prevent-app-suspension`
|
|
|
+is used.
|
|
|
|
|
|
-## powerSaveBlocker.stop(id)
|
|
|
+### `powerSaveBlocker.stop(id)`
|
|
|
|
|
|
* `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`.
|
|
|
|
|
|
Stops the specified power save blocker.
|
|
|
|
|
|
-## powerSaveBlocker.isStarted(id)
|
|
|
+### `powerSaveBlocker.isStarted(id)`
|
|
|
|
|
|
* `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`.
|
|
|
|
|
|
-Returns whether the corresponding `powerSaveBlocker` starts.
|
|
|
+Returns a boolean whether the corresponding `powerSaveBlocker` has started.
|