The Network API provides network and connectivity information.

npm install @capacitor/network
npx cap sync

import { Network } from '@capacitor/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()
• addListener('networkStatusChange', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

getStatus()​

getStatus() => Promise<ConnectionStatus>

Query the current status of the network connection.

Returns:

Promise<ConnectionStatus>

Since: 1.0.0

addListener('networkStatusChange', ...)​

addListener(eventName: 'networkStatusChange', listenerFunc: ConnectionStatusChangeListener) => Promise<PluginListenerHandle>

Listen for changes in the network connection.

ConnectionStatusChangeListener

Returns:

Promise<PluginListenerHandle>

Since: 1.0.0

removeAllListeners()​

removeAllListeners() => Promise<void>

Remove all listeners (including the network status changes) for this plugin.

Since: 1.0.0

Interfaces​

ConnectionStatus​

Represents the state and type of the network connection.

ConnectionType

PluginListenerHandle​

Type Aliases​

ConnectionType​

The type of network connection that a device might have.

'wifi' | 'cellular' | 'none' | 'unknown'

ConnectionStatusChangeListener​

Callback to receive the status change notifications.

(status: ConnectionStatus): void