The Network API provides network and connectivity information.
npm install @jigra/network
npx jig sync
import { Network } from '@jigra/network';
Network.addListener('networkStatusChange', status => {
console.log('Network status changed', status);
});
const logCurrentNetworkStatus = async () => {
const status = await Network.getStatus();
console.log('Network status:', status);
};
getStatus() => Promise<ConnectionStatus>
Query the current status of the network connection.
Returns: Promise<ConnectionStatus>
Since: 1.0.0
addListener(eventName: "networkStatusChange", listenerFunc: ConnectionStatusChangeListener) => Promise<PluginListenerHandle>
Listen for changes in the network connection.
Param | Type |
---|---|
eventName |
'networkStatusChange' |
listenerFunc |
ConnectionStatusChangeListener |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
removeAllListeners() => Promise<void>
Remove all listeners (including the network status changes) for this plugin.
Since: 1.0.0
Represents the state and type of the network connection.
Prop | Type | Description | Since |
---|---|---|---|
connected |
boolean |
Whether there is an active connection or not. | 1.0.0 |
connectionType |
ConnectionType |
The type of network connection currently in use. If there is no active network connection, connectionType will be 'none' . |
1.0.0 |
Prop | Type |
---|---|
remove |
() => Promise<void> |
The type of network connection that a device might have.
"wifi" | "cellular" | "none" | "unknown"
Callback to receive the status change notifications.
(status: ConnectionStatus): void