react-native-location-monitor v0.0.9

Location Monitor is a very simple plugin which runs in the background to monitor location changes such as network and/or geolocation changes.

Installing the plugin

$ npm install react-native-location-monitor --save

Installing the dependencies

react-native-location-monitor uses the two dependencies below.

react-native-background-fetch

$ npm install react-native-background-fetch --save

• iOS Setup
• Android Setup

react-native-network-info

$ npm install react-native-network-info --save
$ react-native link

Config

Common Options

@param {Integer} minimumFetchInterval [15]

The minimum interval in minutes to execute background fetch events. Defaults to 15 minutes. Note: Background-fetch events will never occur at a frequency higher than every 15 minutes. Apple uses a secret algorithm to adjust the frequency of fetch events, presumably based upon usage patterns of the app. Fetch events can occur less often than your configured minimumFetchInterval.

Android Options

@config {Boolean} stopOnTerminate [true]

Set false to continue background-fetch events after user terminates the app. Default to true.

@config {Boolean} startOnBoot [false]

Set true to initiate background-fetch events when the device is rebooted. Defaults to false.

:exclamation: NOTE: startOnBoot requires stopOnTerminate: false.

Usage Example

import {LocationMonitor} from "react-native-location-monitor";

export default class App extends Component {
    constructor(props) {
        super(props);
        let params = { minimumFetchInterval: 15,
                        stopOnTerminate: false,
                        startOnBoot: true };
        let locationMonitorConfig = LocationMonitor.createConfiguration(params);
        LocationMonitor.configure(locationMonitorConfig);
    }
    
    componentDidMount() {
        LocationMonitor.start(
            location => console.log(JSON.stringify(location)),
            err => console.error(err))
            .then(status => {
                switch (status) {
                    case LocationMonitor.Status.READY:
                        console.log("started");
                        break;
                    case LocationMonitor.Status.BACKGROUND_FETCH_DENIED:
                    case LocationMonitor.Status.BACKGROUND_FETCH_RESTRICTED:
                        console.error("did not start");
                        break;
                }});
    }
}

Data

{
  "connection": {
    "type": "",
    "effectiveType": "",
    "ip?": "",
    "ipv4": "",
    "address": "",
    "ssid": "",
    "bssid": ""
  },
  "geoLocation": {
    "altitudeAccuracy": "",
    "accuracy": "",
    "heading": "",
    "longitude": "",
    "altitude": "",
    "speed": ""
  }
}

Contributing

All contributions are very welcome.

Before make a Pull Request please run the linter.

$ npm run lint

Licence

The MIT License

Copyright (c) 2018 LYOS

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.