@transistorsoft/capacitor-background-geolocation 4.3.0 → 4.4.3

package/dist/declarations/BackgroundGeolocation.d.ts

@@ -23,7 +23,7 @@
 /// <reference path="interfaces/Authorization.d.ts" />
 /// <reference path="interfaces/AuthorizationEvent.d.ts" />
 /// <reference path="interfaces/TransistorAuthorizationToken.d.ts" />
-///
+/// <reference path="interfaces/Subscription.d.ts" />
 declare module "@transistorsoft/capacitor-background-geolocation" {
   /**
   * Primary API of the SDK.
@@ -253,6 +253,23 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     */
     static on(event: string, success:Function, failure?:Function):void;
     /**
+    * @deprecated.  Use [[Subscription]] returned from __`BackgroundGeolocation.onXXX`__ to remove listeners.
+    *
+    * @example
+    * ```typescript
+    * const subscription = BackgroundGeolocation.onLocation((location) => {
+    *   console.log('[onLocation]', location);
+    * });
+    * .
+    * .
+    * .
+    * // Remove listener
+    * subscription.remove();
+    * ```
+    *
+    * ---------------------------------------------------------------------
+    * ### ⚠️ [Deprecated]
+    *
     * Removes an event listener.  You must supply the *type* of event to remove in addition to a reference to the *exact* function you
     * used to subscribe to the event.
     *
@@ -274,7 +291,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * let locationHandler = (location) => {
+    * const locationHandler = (location) => {
     *   console.log("[location] - ", location)
     * }
     * BackgroundGeolocation.onLocation(locationHandler)
@@ -293,7 +310,9 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     static un(event: string, handler: Function, success?:Function, failure?:Function): void;
 
     /**
-    * Removes all event-listeners
+    * Removes all event-listeners.
+    *
+    * Calls [[Subscription.remove]] on all subscriptions.
     *
     * @example
     * ```typescript
@@ -314,7 +333,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onLocation((location) => {
+    * const subscription = BackgroundGeolocation.onLocation((location) => {
     *   console.log("[onLocation] success: ", location);
     * }, (error) => {
     *   console.log("[onLocation] ERROR: ", error);
@@ -333,7 +352,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @event location
     */
-    static onLocation(success: (location:Location)=>void, failure?:(errorCode: LocationError) => void):void;
+    static onLocation(success: (location:Location)=>void, failure?:(errorCode: LocationError) => void):Subscription;
 
     /**
     * Subscribe to Geofence transition events.
@@ -342,7 +361,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onGeofence((event) => {
+    * const subscription = BackgroundGeolocation.onGeofence((event) => {
     *   console.log("[onGeofence] ", event);
     * });
     * ```
@@ -352,7 +371,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @event geofence
     */
-    static onGeofence(callback: (event: GeofenceEvent) => void):void;
+    static onGeofence(callback: (event: GeofenceEvent) => void):Subscription;
 
     /**
     * Subscribe to __`motionchange`__ events.
@@ -362,7 +381,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onMotionChange((event) => {
+    * const subscription = BackgroundGeolocation.onMotionChange((event) => {
     *   if (event.isMoving) {
     *      console.log("[onMotionChange] Device has just started MOVING ", event.location);
     *   } else {
@@ -385,14 +404,14 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @event motionchange
     */
-    static onMotionChange(callback: (event:MotionChangeEvent) => void): void;
+    static onMotionChange(callback: (event:MotionChangeEvent) => void): Subscription;
 
     /**
     * Subscribe to HTTP responses from your server [[Config.url]].
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onHttp((response) => {
+    * const subscription = BackgroundGeolocation.onHttp((response) => {
     *   let status = response.status;
     *   let success = response.success;
     *   let responseText = response.responseText;
@@ -404,7 +423,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @event http
     */
-    static onHttp(callback: (response:HttpEvent) => void): void;
+    static onHttp(callback: (response:HttpEvent) => void): Subscription;
 
     /**
     * Subscribe to changes in motion activity.
@@ -416,13 +435,13 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onActivityChange((event) => {
+    * const subscription = BackgroundGeolocation.onActivityChange((event) => {
     *   console.log("[onActivityChange] ", event);
     * });
     * ```
     * @event activitychange
     */
-    static onActivityChange(callback: (event: MotionActivityEvent) => void): void;
+    static onActivityChange(callback: (event: MotionActivityEvent) => void): Subscription;
 
     /**
     * Subscribe to changes in device's location-services configuration / authorization.
@@ -431,7 +450,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onProviderChange((event) => {
+    * const subscription = BackgroundGeolocation.onProviderChange((event) => {
     *   console.log("[onProviderChange: ", event);
     *
     *   switch(event.status) {
@@ -459,7 +478,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @event providerchange
     */
-    static onProviderChange(callback: (event:ProviderChangeEvent) => void): void;
+    static onProviderChange(callback: (event:ProviderChangeEvent) => void): Subscription;
 
     /**
     * Subscribe to periodic heartbeat events.
@@ -469,10 +488,11 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     * @example
     * ```typescript
     * BackgroundGeolocation.ready({
-    *   heartbeatInterval: 60
+    *   heartbeatInterval: 60,
+    *   preventSuspend: true // <-- Required for iOS
     * });
     *
-    * BackgroundGeolocation.onHeartbeat((event) => {
+    * const subscription = BackgroundGeolocation.onHeartbeat((event) => {
     *   console.log("[onHeartbeat] ", event);
     *
     *   // You could request a new location if you wish.
@@ -489,7 +509,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     * -  The [[Location]] provided by the [[HeartbeatEvent]] is only the last-known location.  The *heartbeat* event does not actively engage location-services.  If you wish to get the current location in your `callback`, use [[getCurrentPosition]].
     * @event heartbeat
     */
-    static onHeartbeat(callback: (event: HeartbeatEvent) => void): void;
+    static onHeartbeat(callback: (event: HeartbeatEvent) => void): Subscription;
 
     /**
     * Subscribe to changes in actively monitored geofences.
@@ -508,7 +528,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onGeofencesChange((event) => {
+    * const subscription = BackgroundGeolocation.onGeofencesChange((event) => {
     *   let on = event.on;     //<-- new geofences activated.
     *   let off = event.off; //<-- geofences that were just de-activated.
     *
@@ -528,7 +548,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     * - 📘 [[Geofence | Geofencing Guide]]
     * @event geofenceschange
     */
-    static onGeofencesChange(callback: (event: GeofencesChangeEvent) => void): void;
+    static onGeofencesChange(callback: (event: GeofencesChangeEvent) => void): Subscription;
 
     /**
     * Subscribe to [[schedule]] events.
@@ -538,7 +558,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onSchedule((state) => {
+    * const subscription = BackgroundGeolocation.onSchedule((state) => {
     *   if (state.enabled) {
     *     console.log("[onSchedule] scheduled start tracking");
     *   } else {
@@ -548,7 +568,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     * ```
     * @event schedule
     */
-    static onSchedule(callback: (state:State) => void): void;
+    static onSchedule(callback: (state:State) => void): Subscription;
 
     /**
     * Subscribe to changes in network connectivity.
@@ -561,13 +581,13 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onConnectivityChange((event) => {
+    * const subscription = BackgroundGeolocation.onConnectivityChange((event) => {
     *   console.log("[onConnectivityChange] ", event);
     * });
     * ```
     * @event connectivitychange
     */
-    static onConnectivityChange(callback: (event:ConnectivityChangeEvent) => void): void;
+    static onConnectivityChange(callback: (event:ConnectivityChangeEvent) => void): Subscription;
 
     /**
     * Subscribe to state changes in OS power-saving system.
@@ -592,13 +612,13 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onPowerSaveChange((isPowerSaveMode) => {
+    * const subscription = BackgroundGeolocation.onPowerSaveChange((isPowerSaveMode) => {
     *   console.log("[onPowerSaveChange: ", isPowerSaveMode);
     * });
     * ```
     * @event powersavechange
     */
-    static onPowerSaveChange(callback: (enabled:boolean) => void): void;
+    static onPowerSaveChange(callback: (enabled:boolean) => void): Subscription;
 
     /**
     * Subscribe to changes in plugin [[State.enabled]].
@@ -609,18 +629,18 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onEnabledChange(isEnabled => {
+    * const subscription = BackgroundGeolocation.onEnabledChange(isEnabled => {
     *   console.log("[onEnabledChanged] isEnabled? ", isEnabled);
     * });
     * ```
     * @event enabledchange
     */
-    static onEnabledChange(callback: (enabled:boolean) => void): void;
+    static onEnabledChange(callback: (enabled:boolean) => void): Subscription;
 
     /**
     * [__Android-only__] Subscribe to button-clicks of a custom [[Notification.layout]] on the Android foreground-service notification.
     */
-    static onNotificationAction(callback: (buttonId:string) => void): void;
+    static onNotificationAction(callback: (buttonId:string) => void): Subscription;
 
     /**
     * Subscribe to [[Authorization]] events.
@@ -632,7 +652,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * BackgroundGeolocation.onAuthorization((event) => {
+    * const subscription = BackgroundGeolocation.onAuthorization((event) => {
     *   if (event.success) {
     *     console.log("[authorization] ERROR: ", event.error);
     *   } else {
@@ -642,7 +662,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     * ```
     *
     */
-    static onAuthorization(callback: (event:AuthorizationEvent) => void): void;
+    static onAuthorization(callback: (event:AuthorizationEvent) => void): Subscription;
 
     /**
     * Registers a Javascript callback to execute in the Android "Headless" state, where the app has been terminated configured with
@@ -656,7 +676,7 @@ declare module "@transistorsoft/capacitor-background-geolocation" {
     *
     * @example
     * ```typescript
-    * let BackgroundGeolocationHeadlessTask = async (event) => {
+    * const BackgroundGeolocationHeadlessTask = async (event) => {
     *   let params = event.params;
     *    console.log("[BackgroundGeolocation HeadlessTask] -", event.name, params);
     *

package/dist/declarations/Subscription.d.ts

@@ -0,0 +1,104 @@
+declare module "@transistorsoft/capacitor-background-geolocation" {
+  /**
+  * Object returned by BackgroundGeolocation event-listeners.  `Subscription` contains just a single method [[remove]], used for removing an event-listener.
+  *
+  * - [[BackgroundGeolocation.onLocation]]
+  * - [[BackgroundGeolocation.onMotionChange]]
+  * - [[BackgroundGeolocation.onHttp]]
+  * - [[BackgroundGeolocation.onHeartbeat]]
+  * - [[BackgroundGeolocation.onProviderChange]]
+  * - [[BackgroundGeolocation.onActivityChange]]
+  * - [[BackgroundGeolocation.onGeofence]]
+  * - [[BackgroundGeolocation.onGeofencesChange]]
+  * - [[BackgroundGeolocation.onEnabledChange]]
+  * - [[BackgroundGeolocation.onConnectivityChange]]
+  * - [[BackgroundGeolocation.onSchedule]]
+  * - [[BackgroundGeolocation.onPowerSaveChange]]
+  * - [[BackgroundGeolocation.onNotificationAction]]
+  * - [[BackgroundGeolocation.onAuthorization]]
+  *
+  * In the past, one would remove event-listeners using the __now-deprectated__ [[BackgroundGeolocation.removeListener]].
+  *
+  * ## Removing an event-listener:
+  *
+  * @example
+  * ```typescript
+  * // Event-listeners return a Subscription instance, containing a .remove() method.
+  * const subscription = BackgroundGeolocation.onLocation(location => {
+  *   console.log("[onLocation] ", location);
+  * });
+  * .
+  * .
+  * .
+  * // Later, to remove the event-listener:
+  * subscription.remove();
+  * ```
+  *
+  * One might typically manage a collection of `Subscription` instances
+  *
+  * @example
+  * ```typescript
+  * import BackgroundGeolocation, {
+  *   Location,
+  *   Subscription
+  * } from ...
+  *
+  * // Your custom Collection of Subscription instances.
+  * const SUBSCRIPTIONS = [];
+  *
+  * // Your custom method to push a Subscription instance.
+  * const subscribe = (subscription:Subscription) => {
+  *   SUBSCRIPTIONS.push(subscription);
+  * }
+  *
+  * // Your custom method to interate your SUBSCRIPTIONS and .remove each.
+  * const unsubscribe = () => {
+  *   SUBSCRIPTIONS.forEach((subscription:Subscription) => subscription.remove());
+  * }
+  *
+  * const initBackgroundGeolocation = () {
+  *   // Create event-listeners as usual, feeding the returned Subscription into
+  *   // your custom  subscribe() method.
+  *   subscribe(BackgroundGeolocation.onLocation((location:Location) => {
+  *     console.log('[onLocation]', location);
+  *   });
+  *
+  *   subscribe(BackgroundGeolocation.onMotionChange((location:Location) => {
+  *     console.log('[onMotionChange]', location);
+  *   });
+  *
+  *   subscribe(BackgroundGeolocation.onEnabledChange((enabled:boolean) => {
+  *     console.log('[onEnabledChange]', enabled);
+  *   });
+  * }
+  *
+  * const onDestroyView = () => {
+  *   // Call your custom unsubscribe method
+  *   unsubscribe();
+  * }
+  *
+  * ```
+  */
+  interface Subscription {
+    /**
+     * Removes a `BackgroundGeolocation` event-listener.
+     * @example
+     * ```typescript
+     * // Event-listeners return a Subscription instance, containing a .remove() method.
+     * const onLocationSubscription = BackgroundGeolocation.onLocation(location => {
+     *   console.log("[onLocation] ", location);
+     * });
+     *
+     * const onGeofenceSubscription = BackgroundGeolocation.onGeofence(event => {
+     *   console.log("[onGeofence] ", event);
+     * });
+     * .
+     * .
+     * .
+     * // Later, removing event-listeners.
+     * onLocationSubscription.remove();
+     * onGeofenceSubscription.remove();
+     */
+    remove():void;
+  }
+}

package/dist/declarations/interfaces/Subscription.d.ts

@@ -0,0 +1,104 @@
+declare module "@transistorsoft/capacitor-background-geolocation" {
+  /**
+  * Object returned by BackgroundGeolocation event-listeners.  `Subscription` contains just a single method [[remove]], used for removing an event-listener.
+  *
+  * - [[BackgroundGeolocation.onLocation]]
+  * - [[BackgroundGeolocation.onMotionChange]]
+  * - [[BackgroundGeolocation.onHttp]]
+  * - [[BackgroundGeolocation.onHeartbeat]]
+  * - [[BackgroundGeolocation.onProviderChange]]
+  * - [[BackgroundGeolocation.onActivityChange]]
+  * - [[BackgroundGeolocation.onGeofence]]
+  * - [[BackgroundGeolocation.onGeofencesChange]]
+  * - [[BackgroundGeolocation.onEnabledChange]]
+  * - [[BackgroundGeolocation.onConnectivityChange]]
+  * - [[BackgroundGeolocation.onSchedule]]
+  * - [[BackgroundGeolocation.onPowerSaveChange]]
+  * - [[BackgroundGeolocation.onNotificationAction]]
+  * - [[BackgroundGeolocation.onAuthorization]]
+  *
+  * In the past, one would remove event-listeners using the __now-deprectated__ [[BackgroundGeolocation.removeListener]].
+  *
+  * ## Removing an event-listener:
+  *
+  * @example
+  * ```typescript
+  * // Event-listeners return a Subscription instance, containing a .remove() method.
+  * const subscription = BackgroundGeolocation.onLocation(location => {
+  *   console.log("[onLocation] ", location);
+  * });
+  * .
+  * .
+  * .
+  * // Later, to remove the event-listener:
+  * subscription.remove();
+  * ```
+  *
+  * One might typically manage a collection of `Subscription` instances
+  *
+  * @example
+  * ```typescript
+  * import BackgroundGeolocation, {
+  *   Location,
+  *   Subscription
+  * } from ...
+  *
+  * // Your custom Collection of Subscription instances.
+  * const SUBSCRIPTIONS = [];
+  *
+  * // Your custom method to push a Subscription instance.
+  * const subscribe = (subscription:Subscription) => {
+  *   SUBSCRIPTIONS.push(subscription);
+  * }
+  *
+  * // Your custom method to interate your SUBSCRIPTIONS and .remove each.
+  * const unsubscribe = () => {
+  *   SUBSCRIPTIONS.forEach((subscription:Subscription) => subscription.remove());
+  * }
+  *
+  * const initBackgroundGeolocation = () {
+  *   // Create event-listeners as usual, feeding the returned Subscription into
+  *   // your custom  subscribe() method.
+  *   subscribe(BackgroundGeolocation.onLocation((location:Location) => {
+  *     console.log('[onLocation]', location);
+  *   });
+  *
+  *   subscribe(BackgroundGeolocation.onMotionChange((location:Location) => {
+  *     console.log('[onMotionChange]', location);
+  *   });
+  *
+  *   subscribe(BackgroundGeolocation.onEnabledChange((enabled:boolean) => {
+  *     console.log('[onEnabledChange]', enabled);
+  *   });
+  * }
+  *
+  * const onDestroyView = () => {
+  *   // Call your custom unsubscribe method
+  *   unsubscribe();
+  * }
+  *
+  * ```
+  */
+  interface Subscription {
+    /**
+     * Removes a `BackgroundGeolocation` event-listener.
+     * @example
+     * ```typescript
+     * // Event-listeners return a Subscription instance, containing a .remove() method.
+     * const onLocationSubscription = BackgroundGeolocation.onLocation(location => {
+     *   console.log("[onLocation] ", location);
+     * });
+     *
+     * const onGeofenceSubscription = BackgroundGeolocation.onGeofence(event => {
+     *   console.log("[onGeofence] ", event);
+     * });
+     * .
+     * .
+     * .
+     * // Later, removing event-listeners.
+     * onLocationSubscription.remove();
+     * onGeofenceSubscription.remove();
+     */
+    remove():void;
+  }
+}

package/dist/index.js

@@ -706,85 +706,106 @@ var BackgroundGeolocation = /** @class */ (function () {
     /// Event Handling
     ///
     BackgroundGeolocation.onLocation = function (success, failure) {
-        BackgroundGeolocation.addListener(Events.LOCATION, success, failure);
+        return BackgroundGeolocation.addListener(Events.LOCATION, success, failure);
     };
     BackgroundGeolocation.onMotionChange = function (success) {
-        BackgroundGeolocation.addListener(Events.MOTIONCHANGE, success);
+        return BackgroundGeolocation.addListener(Events.MOTIONCHANGE, success);
     };
     BackgroundGeolocation.onHttp = function (success) {
-        BackgroundGeolocation.addListener(Events.HTTP, success);
+        return BackgroundGeolocation.addListener(Events.HTTP, success);
     };
     BackgroundGeolocation.onHeartbeat = function (success) {
-        BackgroundGeolocation.addListener(Events.HEARTBEAT, success);
+        return BackgroundGeolocation.addListener(Events.HEARTBEAT, success);
     };
     BackgroundGeolocation.onProviderChange = function (success) {
-        BackgroundGeolocation.addListener(Events.PROVIDERCHANGE, success);
+        return BackgroundGeolocation.addListener(Events.PROVIDERCHANGE, success);
     };
     BackgroundGeolocation.onActivityChange = function (success) {
-        BackgroundGeolocation.addListener(Events.ACTIVITYCHANGE, success);
+        return BackgroundGeolocation.addListener(Events.ACTIVITYCHANGE, success);
     };
     BackgroundGeolocation.onGeofence = function (success) {
-        BackgroundGeolocation.addListener(Events.GEOFENCE, success);
+        return BackgroundGeolocation.addListener(Events.GEOFENCE, success);
     };
     BackgroundGeolocation.onGeofencesChange = function (success) {
-        BackgroundGeolocation.addListener(Events.GEOFENCESCHANGE, success);
+        return BackgroundGeolocation.addListener(Events.GEOFENCESCHANGE, success);
     };
     BackgroundGeolocation.onSchedule = function (success) {
-        BackgroundGeolocation.addListener(Events.SCHEDULE, success);
+        return BackgroundGeolocation.addListener(Events.SCHEDULE, success);
     };
     BackgroundGeolocation.onEnabledChange = function (success) {
-        BackgroundGeolocation.addListener(Events.ENABLEDCHANGE, success);
+        return BackgroundGeolocation.addListener(Events.ENABLEDCHANGE, success);
     };
     BackgroundGeolocation.onConnectivityChange = function (success) {
-        BackgroundGeolocation.addListener(Events.CONNECTIVITYCHANGE, success);
+        return BackgroundGeolocation.addListener(Events.CONNECTIVITYCHANGE, success);
     };
     BackgroundGeolocation.onPowerSaveChange = function (success) {
-        BackgroundGeolocation.addListener(Events.POWERSAVECHANGE, success);
+        return BackgroundGeolocation.addListener(Events.POWERSAVECHANGE, success);
     };
     BackgroundGeolocation.onNotificationAction = function (success) {
-        BackgroundGeolocation.addListener(Events.NOTIFICATIONACTION, success);
+        return BackgroundGeolocation.addListener(Events.NOTIFICATIONACTION, success);
     };
     BackgroundGeolocation.onAuthorization = function (success) {
-        BackgroundGeolocation.addListener(Events.AUTHORIZATION, success);
+        return BackgroundGeolocation.addListener(Events.AUTHORIZATION, success);
     };
     ///
     /// Listen to a plugin event
     ///
     BackgroundGeolocation.addListener = function (event, success, failure) {
-        return __awaiter(this, void 0, void 0, function () {
-            var handler, listener;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!Events[event.toUpperCase()]) {
-                            throw (TAG + "#addListener - Unknown event '" + event + "'");
-                        }
-                        handler = function (response) {
-                            if (response.hasOwnProperty("value")) {
-                                response = response.value;
-                            }
-                            if (response.hasOwnProperty("error") && (response.error != null)) {
-                                if (typeof (failure) === 'function') {
-                                    failure(response.error);
-                                }
-                                else {
-                                    success(response);
-                                }
-                            }
-                            else {
-                                success(response);
-                            }
-                        };
-                        return [4 /*yield*/, NativeModule.addListener(event, handler)];
-                    case 1:
-                        listener = _a.sent();
-                        EVENT_SUBSCRIPTIONS.push(new Subscription(event, listener, success));
-                        return [2 /*return*/];
+        if (!Events[event.toUpperCase()]) {
+            throw (TAG + "#addListener - Unknown event '" + event + "'");
+        }
+        var handler = function (response) {
+            if (response.hasOwnProperty("value")) {
+                response = response.value;
+            }
+            if (response.hasOwnProperty("error") && (response.error != null)) {
+                if (typeof (failure) === 'function') {
+                    failure(response.error);
                 }
-            });
+                else {
+                    success(response);
+                }
+            }
+            else {
+                success(response);
+            }
+        };
+        // Create a flag to capture edge-case where the developer subscribes to an event then IMMEDIATELY calls subscription.remove()
+        // before NativeModule.addListener has resolved.
+        // The developer would have to do something weird like this:
+        //   const subscription = BackgroundGeolocation.onLocation(this.onLocation);
+        //   subscription.remove();
+        //
+        // The reason for this is I don't want developers to have to await calls to BackgroundGeolocation.onXXX(myHandler).
+        //
+        var isRemoved = false;
+        var subscriptionProxy = {
+            remove: function () {
+                // EmptyFn until NativeModule.addListener resolves and re-writes this function
+                isRemoved = true;
+                console.warn('[BackgroundGeolocation.addListener] Unexpected call to subscription.remove() on subscriptionProxy.  Waiting for NativeModule.addListener to resolve.');
+            }
+        };
+        // Now add the listener and re-write subscriptionProxy.remove.
+        NativeModule.addListener(event, handler).then(function (listener) {
+            var subscription = new Subscription(event, listener, success);
+            EVENT_SUBSCRIPTIONS.push(subscription);
+            subscriptionProxy.remove = function () {
+                listener.remove();
+                // Remove from EVENT_SUBSCRIPTIONS.
+                if (EVENT_SUBSCRIPTIONS.indexOf(subscription) >= 0) {
+                    EVENT_SUBSCRIPTIONS.splice(EVENT_SUBSCRIPTIONS.indexOf(subscription), 1);
+                }
+            };
+            if (isRemoved) {
+                // Caught edge-case.  Developer added an event-handler then immediately call subscription.remove().
+                subscriptionProxy.remove();
+            }
         });
+        return subscriptionProxy;
     };
     BackgroundGeolocation.removeListener = function (event, callback) {
+        console.warn('BackgroundGeolocation.removeListener is deprecated.  Event-listener methods (eg: onLocation) now return a Subscription instance.  Call subscription.remove() on the returned subscription instead.  Eg:\nconst subscription = BackgroundGeolocation.onLocation(myLocationHandler)\n...\nsubscription.remove()');
         return new Promise(function (resolve, reject) {
             var found = null;
             for (var n = 0, len = EVENT_SUBSCRIPTIONS.length; n < len; n++) {