mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-02-21 00:23:00 +08:00
docs(batterystatus): improve docs
This commit is contained in:
parent
848d70631c
commit
046d17e574
@ -2,7 +2,7 @@ import {Plugin} from './plugin';
|
||||
import {Observable} from "rxjs/Observable";
|
||||
|
||||
/**
|
||||
*
|
||||
* @name Battery Status
|
||||
*
|
||||
* Requires Cordova plugin: cordova-plugin-batterystatus. For more info, please see the [BatteryStatus plugin docs](https://github.com/apache/cordova-plugin-battery-status).
|
||||
*
|
||||
@ -12,13 +12,16 @@ import {Observable} from "rxjs/Observable";
|
||||
*
|
||||
* @usage
|
||||
* ```js
|
||||
*
|
||||
* BatteryStatus.onChange().subscribe(
|
||||
* // watch change in battery status
|
||||
* let subscription = BatteryStatus.onChange().subscribe(
|
||||
* status => {
|
||||
*
|
||||
* console.log(status);
|
||||
* }
|
||||
* );
|
||||
*
|
||||
* // stop watch
|
||||
* subscription.unsubscribe();
|
||||
*
|
||||
* ```
|
||||
*/
|
||||
@Plugin({
|
||||
@ -27,7 +30,7 @@ import {Observable} from "rxjs/Observable";
|
||||
export class BatteryStatus {
|
||||
|
||||
/**
|
||||
* Watches the change in battery level
|
||||
* Watch the change in battery level
|
||||
* @returns {Observable} Returns an observable that pushes the new battery level
|
||||
*/
|
||||
static onChange () : Observable<any> {
|
||||
@ -38,4 +41,4 @@ export class BatteryStatus {
|
||||
});
|
||||
}
|
||||
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue
Block a user