rescript-react-native/netinfoPublic

NotificationsYou must be signed in to change notification settings
Fork2
Star9

ReScript bindings for @react-native-community/netinfo

License

MIT license

9 stars 2 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 1,156 Commits
.github/workflows		.github/workflows
src		src
.editorconfig		.editorconfig
.gitignore		.gitignore
.prettierignore		.prettierignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
bsconfig.json		bsconfig.json
package.json		package.json
yarn.lock		yarn.lock

Repository files navigation

`@rescript-react-native/netinfo`

ReScript bindings for@react-native-community/netinfo.

Exposed asReactNativeNetInfo module.

@rescript-react-native/netinfo X.y.* means it's compatible with@react-native-community/netinfo X.y.*

Installation

When@react-native-community/netinfois properly installed & configured by following their installation instructions,you can install the bindings:

npm install @rescript-react-native/netinfo#oryarn add @rescript-react-native/netinfo

@rescript-react-native/netinfo should be added tobs-dependencies in yourbsconfig.json:

{  //...  "bs-dependencies": [    "@rescript/react",    "rescript-react-native",    // ...+    "@rescript-react-native/netinfo"  ],  //...}

Usage

Types

`netInfoConfiguration`

To be used only when the platform does not natively supply information oninternet reachability.

Property	Type	Description
`reachabilityUrl`	`string`	URL used to test if the internet is reachable.
`reachabilityTest`	`response => bool`	A function to handle the`response` object returned when the reachability URL is called. It should return`true` if the response indicates that the internet is reachable.
`reachabilityShortTimeout`	`float`	Number of seconds between internet reachability checks when the internet was not previously detected.
`reachabilityLongTimeout`	`float`	Number of seconds between internet reachability checks when the internet was previously detected.
`reachabilityRequestTimeout`	`float`	Number of milliseconds allowed before reachability check fails.

`netInfoStateType`

Kind of the current network connection. Valid values are:

Value	Platforms	Connection State
`none`	Android, iOS, Windows	Not active
`unknown`	Android, iOS, Windows	Undetermined
`cellular`	Android, iOS, Windows	Active
`wifi`	Android, iOS, Windows	Active
`bluetooth`	Android	Active
`ethernet`	Android, Windows	Active
`wimax`	Android	Active
`vpn`	Android	Active
`other`	Android, iOS, Windows	Active

`netInfoCellularGeneration`

Cellular generation of the current network connection. Valid values are:

Value	Notes
`net2g`	Inlined as "2g". Returned for CDMA, EDGE, GPRS and IDEN connections
`net3g`	Inlined as "3g". Returned for EHRPD, EVDO, HSPA, HSUPA, HSDPA and UTMS connections.
`net4g`	Inlined as "4g". Returned for HSPAP and LTE connections

`netInfoState`

typenetInfoState= {  ."_type":netInfoStateType,"isConnected":bool,"isInternetReachable":bool,"isWifiEnabled":bool,"details":Js.Null.t(details),};

isConnected will betrue if there is an active connection (but not implythat the internet is necessarily reachable).
isInternetReachable will betrue if the internet can be reached using theactive connection
isWifiEnabled will betrue if WiFi is enabled on the device, andfalseotherwise.Android only.

details key will have valueJs.Null.empty (null) when_type isnull orunknown.

`details`

details depends on_type given withinnetInfoState. If_type is notnull orunknown,details is an object as below:

typedetails= {  ."isConnectionExpensive":bool,"ssid":Js.Nullable.t(string),"strength":Js.Nullable.t(int),"ipAddress":Js.Nullable.t(string),"subnet":Js.Nullable.t(string),"cellularGeneration":Js.Nullable.t(netInfoCellularGeneration),"carrier":Js.Nullable.t(string),};

Property	Platform	Type	Description
`isConnectionExpensive`	Android, iOS, Windows	`bool`	If network connection is consideredexpensive in either energy or monetary terms.

Note that some keys may only exist in the JS object when_type iswifi orcellular. Accordingly, in Reason, keys may have valuesJs.Nullable.undefined.

ssid,strength,ipAddress andsubnet will have valueJs.Nullable.undefined unless_type iswifi.
cellularGeneration andcarrier will have valueJs.Nullable.undefinedunless_type is cellular.

`_type` is`wifi`

Property	Platform	Type	Description
`ssid`	Android, iOS (not tvOS)	`Js.Nullable.t(string)`	SSID of the network. May have value`Js.Nullable.undefined`,`Js.Nullable.null`, or be an empty string if undetermined.On iOS, make sure your app meets at least one of thefollowing requirements. On Android, make sure the`ACCESS_FINE_LOCATION` permission is listed in`AndroidManifest.xml` and accepted by the user.
`strength`	Android	`Js.Nullable.t(string)`	If signal strength can be determined, will be an integer number from`0` to`5`. May have value`Js.Nullable.undefined` otherwise.
`ipAddress`	Android, iOS	`Js.Nullable.t(string)`	External IP address. Can be in IPv4 or IPv6 format. May have value`Js.Nullable.undefined` if undetermined.
`subnet`	Android, iOS	`Js.Nullable.t(string)`	The subnet mask in IPv4 format. May have value`Js.Nullable.undefined` if undetermined.

`type` is`cellular`

Property	Platform	Type	Description
`cellularGeneration`	Android, iOS, Windows	`NetInfoCellularGeneration`	Generation of cell network the user is connected to. This can give an indication of speed, but no guarantees. May have value`Js.Nullable.null` if generation cannot be determined.
`carrier`	Android, iOS	`string`	The network carrier name. May have value`Js.Nullable.undefined` or may be empty if undetermined.

Methods

`configure`

configure:netInfoConfiguration=>unit

`fetch`

To query state of the active connection, returnsnetInfoState wrapped in aPromise.

fetch:unit=>Js.Promise.t(netInfoState)

Below example demonstrates determination of the cellular connection generation,using this method.

React.useEffect0(()=> {Js.Promise.(ReactNativeNetInfo.fetch()|>then_(w=>         {switch (w##details->Js.Null.toOption) {           |None=>"Connection type is none or unknown"->Js.Console.warn           |Some(x)=>lety=x##cellularGeneration;switch (y->Js.Nullable.toOption) {             |None=>if (y==Js.Nullable.undefined) {"Connection type is wifi, bluetooth, ethernet, wimax, vpn or other"->Js.Console.warn;               }else {"Connection generation unknown"->Js.Console.warn;               }             |Some(z)=>if (z==ReactNativeNetInfo.net2G) {"2G connection"->Js.Console.warn;               }elseif (z==ReactNativeNetInfo.net3G) {"3G connection"->Js.Console.warn;               }else {"4G connection"->Js.Console.warn;               }             };           };         }->resolve       )|>catch(err=>"error"->Js.Console.warn->resolve)|>ignore  );None;});

`fetchInterface`

To query the connection state for a particular interface.

fetchInterface: [ |`cellular | `ethernet |`wifi] => Js.Promise.t(netInfoState)

`addEventListener`

To subscribe to the connection state; accepts a listener of typenetInfoState => unit and returns an unsubscribe method of typeunit => unit.The listener will be called once following subscription and each time connectionstate changes.

addEventListener: (netInfoState=>unit)=>t

where

typet=unit=>unit

Below example demonstrates subscribing to changes in connection state:

React.useEffect0(()=> {letremove=ReactNativeNetInfo.addEventListener(w=>      (switch (w##details->Js.Null.toOption) {        |None=>"Connection type is none or unknown"        |Some(x)=>lety=x##cellularGeneration;switch (y->Js.Nullable.toOption) {          |None=>if (y==Js.Nullable.undefined) {"Connection type is wifi, bluetooth, ethernet, wimax, vpn or other";            }else {"Connection generation unknown";            }          |Some(z)=>if (z==ReactNativeNetInfo.net2G) {"2G connection";            }elseif (z==ReactNativeNetInfo.net3G) {"3G connection";            }else {"4G connection";            }          };        }      )->Js.Console.warn    );Js.Console.warn(remove);Some(()=>remove());});

`useNetInfo`

This method returns a React Hook with typenetInfoState

useNetInfo:unit=>netInfoState

Below example demonstrates its use within aText component:

<Text>  (switch (ReactNativeNetInfo.useNetInfo()##details->Js.Null.toOption) {    |None=>"Connection type is none or unknown"    |Some(x)=>lety=x##cellularGeneration;switch (y->Js.Nullable.toOption) {      |None=>if (y==Js.Nullable.undefined) {"Connection type is wifi, bluetooth, ethernet, wimax, vpn or other";        }else {"Connection generation unknown";        }      |Some(z)=>if (z==ReactNativeNetInfo.net2G) {"2G connection";        }elseif (z==ReactNativeNetInfo.net3G) {"3G connection";        }else {"4G connection";        }      };    }  )->React.string</Text>

Changelog

Check thechangelog for more informations about recentreleases.

Contribute

Read thecontribution guidelinesbefore contributing.

Code of Conduct

We want this community to be friendly and respectful to each other. Please readour full code of conductso that you can understand what actions will and will not be tolerated.