github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-02-22 01:19:36 +08:00
Code Issues Projects Releases Wiki Activity

docs(batterystatus): improve docs

Browse Source
This commit is contained in:
Ibrahim Hadeed 2016-03-10 15:14:55 -05:00
parent 848d70631c
commit 046d17e574
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/plugins/batterystatus.ts
View File

@ -2,7 +2,7 @@ import {Plugin} from './plugin';
import {Observable} from "rxjs/Observable"; 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). * 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 * @usage
* ```js * ```js
* * // watch change in battery status
* BatteryStatus.onChange().subscribe( * let subscription = BatteryStatus.onChange().subscribe(
* status => { * status => {
* * console.log(status);
* } * }
* ); * );
* *
* // stop watch
* subscription.unsubscribe();
*
* ``` * ```
*/ */
@Plugin({ @Plugin({
@ -27,7 +30,7 @@ import {Observable} from "rxjs/Observable";
export class BatteryStatus { 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 * @returns {Observable} Returns an observable that pushes the new battery level
*/ */
static onChange () : Observable<any> { static onChange () : Observable<any> {
@ -38,4 +41,4 @@ export class BatteryStatus {
}); });
} }
} }