awesome-cordova-plugins/src/plugins/batterystatus.ts

56 lines
1.3 KiB
TypeScript
Raw Normal View History

2016-03-07 01:48:20 +08:00
import {Plugin} from './plugin';
import {Observable} from "rxjs/Observable";
/**
2016-03-11 04:14:55 +08:00
* @name Battery Status
2016-03-07 01:48:20 +08:00
*
* Requires Cordova plugin: cordova-plugin-batterystatus. For more info, please see the [BatteryStatus plugin docs](https://github.com/apache/cordova-plugin-battery-status).
*
* ```
* cordova plugin add cordova-plugin-batterystatus
* ```
*
* @usage
* ```js
2016-03-11 04:14:55 +08:00
* // watch change in battery status
* let subscription = BatteryStatus.onChange().subscribe(
2016-03-07 01:48:20 +08:00
* status => {
2016-03-11 04:14:55 +08:00
* console.log(status);
2016-03-07 01:48:20 +08:00
* }
* );
*
2016-03-11 04:14:55 +08:00
* // stop watch
* subscription.unsubscribe();
*
2016-03-07 01:48:20 +08:00
* ```
*/
@Plugin({
plugin: 'cordova-plugin-batterystatus'
})
export class BatteryStatus {
/**
2016-03-11 04:14:55 +08:00
* Watch the change in battery level
* @returns {Observable} Returns an observable that pushes a status object
2016-03-07 01:48:20 +08:00
*/
static onChange () : Observable<StatusObject> {
2016-03-07 01:48:20 +08:00
return new Observable(observer => {
let callback = (status : any) => observer.next(status);
window.addEventListener("batterystatus", callback, false);
return () => window.removeEventListener("batterystatus", callback, false);
});
}
}
interface StatusObject {
/**
* The battery charge percentage
*/
level : number,
/**
* A boolean that indicates whether the device is plugged in
*/
isPlugged : boolean
2016-03-11 04:14:55 +08:00
}