Expo NetworkGitHub
npm
expo-network provides useful information about the device's network such as its IP address, MAC address, and airplane mode status.
Platform Compatibility
| Android Device | Android Emulator | iOS Device | iOS Simulator | Web |
|---|---|---|---|---|
Installation
- npx expo install expo-networkIf you're installing this in a bare React Native app, you should also follow these additional installation instructions.
Configuration
On Android, this module requires permissions to access the network and Wi-Fi state. The permissions ACCESS_NETWORK_STATE and ACCESS_WIFI_STATE are added automatically.
API
import * as Network from 'expo-network';
Methods
Network.getIpAddressAsync()
Gets the device's current IPv4 address. Returns 0.0.0.0 if the IP address could not be retrieved.
On web, this method uses the third-party ipify service to get the
public IP address of the current device.
Example
await Network.getIpAddressAsync(); // "92.168.32.44"
Returns
Promise<string>
A Promise that fulfils with a string of the current IP address of the device's main
network interface. Can only be IPv4 address.
Deprecated. This method is deprecated and will be removed in a future SDK version.
Network.getMacAddressAsync(interfaceName)
| Name | Type | Description |
|---|---|---|
| interfaceName (optional) | null | string | A string representing interface name ( Default: null |
Gets the specified network interface's MAC address.
Beginning with iOS 7 and Android 11, non-system applications can no longer access the device's MAC address. In SDK 41 and above, this method will always resolve to a predefined value that isn't useful.
If you need to identify the device, use the getIosIdForVendorAsync() method / androidId
property of the expo-application unimodule instead.
Returns
Promise<string>
A Promise that fulfils with the value '02:00:00:00:00:00'.
Network.getNetworkStateAsync()
Gets the device's current network connection state.
On web, navigator.connection.type is not available on browsers. So if there is an active
network connection, the field type returns NetworkStateType.UNKNOWN. Otherwise, it returns
NetworkStateType.NONE.
Example
await Network.getNetworkStateAsync(); // { // type: NetworkStateType.CELLULAR, // isConnected: true, // isInternetReachable: true, // }
Returns
A Promise that fulfils with a NetworkState object.
Network.isAirplaneModeEnabledAsync()
Tells if the device is in airplane mode.
Example
await Network.isAirplaneModeEnabledAsync(); // false
Returns
Promise<boolean>
Returns a Promise that fulfils with a boolean value for whether the device is in
airplane mode or not.
Types
NetworkState
| Name | Type | Description |
|---|---|---|
| isConnected (optional) | boolean | If there is an active network connection. Note that this does not mean that internet is reachable.
This field is |
| isInternetReachable (optional) | boolean | If the internet is reachable with the currently active network connection. On Android, this
depends on |
| type (optional) | NetworkStateType | A |
Enums
NetworkStateType
An enum of the different types of devices supported by Expo.
CELLULAR
NetworkStateType.CELLULAR ＝ "CELLULAR"Active network connection over mobile data or DUN-specific
mobile connection when setting an upstream connection for tethering.
Error Codes
| Code | Description |
|---|---|
| ERR_NETWORK_IP_ADDRESS | On Android, there may be an unknown Wi-Fi host when trying to access WifiManager in getIpAddressAsync. On iOS, no network interfaces could be retrieved. |
| ERR_NETWORK_UNDEFINED_INTERFACE | An undefined interfaceName was passed as an argument in getMacAddressAsync. |
| ERR_NETWORK_SOCKET_EXCEPTION | An error was encountered in creating or accessing the socket in getMacAddressAsync. |
| ERR_NETWORK_INVALID_PERMISSION_INTERNET | There are invalid permissions for android.permission.ACCESS_WIFI_STATE in getMacAddressAsync. |
| ERR_NETWORK_NO_ACCESS_NETWORKINFO | Unable to access network information |