https://github.com/sudoplz/react-native-connectivity-tracker

Checks (verifies) wether there's a valid internet connection
https://github.com/sudoplz/react-native-connectivity-tracker

netinfo react-native

Last synced: 3 months ago
JSON representation

Checks (verifies) wether there's a valid internet connection

• Host: GitHub
• URL: https://github.com/sudoplz/react-native-connectivity-tracker
• Owner: SudoPlz
• License: mit
• Created: 2018-09-19T19:20:47.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-16T17:34:30.000Z (over 4 years ago)
• Last Synced: 2024-09-29T01:04:28.007Z (4 months ago)
• Topics: netinfo, react-native
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 10
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## react-native-connectivity-tracker

### Why?

Because we can no longer trust that react-native connectivity changes are valid, so we have to double check before we trust the result.

Here's the [RN issue](https://github.com/facebook/react-native/issues/8615)

### How?

The only thing this library does is, whenever a network change event get's dispatched by `NetInfo`, we verify that the connection is alive by pinging google.

p.s: On production we verify by checking if our server is up (by overriding `verifyServersAreUp`) but you don't have to do that.

### Versions:

- react-native >= 0.58  --> react-native-connectivity tracker > 2.0.0

- react-native < 0.58  --> react-native-connectivity tracker > 1.0.0

### Installation:

`yarn install react-native-connectivity-tracker`

#### Extra steps on if you're using version >= 2.0.0 (not needed if on a previous version)

Manually link the library on iOS

Either follow the [instructions in the React Native documentation](https://facebook.github.io/react-native/docs/linking-libraries-ios#manual-linking) to manually link the framework or link using [Cocoapods](https://cocoapods.org) by adding this to your `Podfile`:

```ruby

pod 'react-native-netinfo', :path => '../node_modules/@react-native-community/netinfo'

```

Manually link the library on Android

Make the following changes:

#### `android/settings.gradle`

```groovy

include ':react-native-community-netinfo'

project(':react-native-community-netinfo').projectDir = new File(rootProject.projectDir, '../node_modules/@react-native-community/netinfo/android')

```

#### `android/app/build.gradle`

```groovy

dependencies {

   ...

   implementation project(':react-native-community-netinfo')

}

```

#### `android/app/src/main/.../MainApplication.java`

On top, where imports are:

```java

import com.reactnativecommunity.netinfo.NetInfoPackage;

```

Add the `NetInfoPackage` class to your list of exported packages.

```java

@Override

protected List getPackages() {

    return Arrays.asList(

            new MainReactPackage(),

            new NetInfoPackage()

    );

}

```

### Usage:

```javascript

import ConnectivityTracker from 'react-native-connectivity-tracker';

const onConnectivityChange = (isConnected, timestamp, connectionInfo) => {

    console.log(`isConnected: ${isConnected}, when: ${timestamp} more info: ${JSON.stringify(connectionInfo)}`)

    // connectionInfo is only available if attachConnectionInfo is set to true

}

ConnectivityTracker.init({

    onConnectivityChange,

    attachConnectionInfo: false,

    onError: msg => console.log(msg),

    // verifyServersAreUp: () => store.dispatch(checkOurServersAreUp()),

});

```

    

### Params:

|Key 	| Type 	| Default	| Definition	 |

| ---	| --- 	| ---- 		| ----------- 	 |

| **onConnectivityChange**  	| function(bool, Date, Object)  | -  | This is the main callback you should care about. It get's dispatched whenever there's a connectivity change. |

| **attachConnectionInfo**   	| boolean  			| false | Attaches more details about the connection on the `onConnectivityChange` callback (3rd param) |

| **alsoVerifyOnlineStatuses**   	| boolean  			| false | By default we only verify the connectivity whenever we receive an offline status. By turning this on we'll also verify online statuses too. |

| **dispatchOldEventsToo**   	| boolean  			| false | By default we only dispatch the latest event we received from NetInfo. By turning this on we'll dispatch EVERYTHING. Caution, the order of events is not guaranteed if this is set to true. |

| **onError** 			| function  			| - | Pass a function here if you want to log errors.   |

| **verifyServersAreUp**   	| function 		| - | This overrides the default verification method. Feel free to disregard this, unless  want to use your own verification method, instead of relying to google responces. This function can return either a result (true or false) or a Promise  |

### Methods:

|Key 	|  Definition	 |

| ---	|  ----------- 	 |

| **tryConnection**   | This is a tottally optional method that you can call when you wish to check for a connectivity status on demand. Returnes a promise.|