react-native-background-geolocation/src/declarations/interfaces/GeofencesChangeEvent.d.ts

The most sophisticated cross-platform background location-tracking & geofencing module with battery-conscious motion-detection intelligence

/// <reference path="./Geofence.d.ts" />
///
declare module "react-native-background-geolocation" {
  /**
  * The event-object provided to [[BackgroundGeolocation.onGeofencesChange]].
  *
  * The [[GeofencesChangeEvent]] provides only the *changed* geofences, those which just activated or de-activated.
  *
  * @example
  * ```typescript
  * BackgroundGeolocation.onGeofencesChange(geofencesChangeEvent => {
  *   console.log("[geofenceschange] ", geofencesChangeEvent.on, geofencesChangeEvent.off);
  * });
  * ```
  * ### ⚠️ Note:
    * - When **all** geofences have been removed, empty lists will be provided for both [[on]] & [[off]].
  */
  interface GeofencesChangeEvent {
    on: Array<Geofence>;
    off: Array<string>;
  }
}