awesome-cordova-plugins/src/plugins/batterystatus.ts
Ibrahim Hadeed 35bfe40d9e refactor(batterystatus): extract getObservable() from class
extracted the getObservable() function from class so it doesn't show as a method (in docs and

auto-complete)
2016-03-10 15:27:01 -05:00

81 lines
2.0 KiB
TypeScript

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).
*
* ```
* cordova plugin add cordova-plugin-batterystatus
* ```
*
* @usage
* ```js
* // watch change in battery status
* let subscription = BatteryStatus.onChange().subscribe(
* status => {
* console.log(status.level, status.isPlugged);
* }
* );
*
* // stop watch
* subscription.unsubscribe();
*
* ```
*/
@Plugin({
plugin: 'cordova-plugin-batterystatus'
})
export class BatteryStatus {
/**
* Watch the change in battery level
* @returns {Observable} Returns an observable that pushes a status object
*/
static onChange () : Observable<StatusObject> {
return getEventObservable("batterylevel");
}
/**
* Watch when the battery level goes low
* @returns {Observable<StatusObject>} Returns an observable that pushes a status object
*/
static onLow () : Observable<StatusObject> {
return getEventObservable("batterylow");
}
/**
* Watch when the battery level goes to critial
* @returns {Observable<StatusObject>} Returns an observable that pushes a status object
*/
static onCritical () : Observable<StatusObject> {
return getEventObservable("batterycritical");
}
}
interface StatusObject {
/**
* The battery charge percentage
*/
level : number,
/**
* A boolean that indicates whether the device is plugged in
*/
isPlugged : boolean
}
/**
* Wrap the event with an observable
* @param event
* @returns {Observable}
*/
function getEventObservable (event : string) : Observable<StatusObject> {
return new Observable(observer => {
let callback = (status : any) => observer.next(status);
window.addEventListener(event, callback, false);
return () => window.removeEventListener(event, callback, false);
});
}