@capacitor/network

Network API 提供网络连接状态信息。

安装

npm install @capacitor/network@latest-5
npx cap sync

示例

import { Network } from '@capacitor/network';

Network.addListener('networkStatusChange', (status) => {
  console.log('网络状态变更', status);
});

const logCurrentNetworkStatus = async () => {
  const status = await Network.getStatus();

  console.log('当前网络状态:', status);
};

API

• getStatus()
• addListener('networkStatusChange', ...)
• removeAllListeners()
• 接口
• 类型别名

getStatus()

getStatus() => Promise<ConnectionStatus>

查询当前网络连接状态。

返回值:

Promise<ConnectionStatus>

自: 1.0.0

---

addListener('networkStatusChange', ...)

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

监听网络连接状态变化。

参数	类型
eventName	'networkStatusChange'
listenerFunc	ConnectionStatusChangeListener

返回值:

Promise<PluginListenerHandle> & PluginListenerHandle

自: 1.0.0

---

removeAllListeners()

removeAllListeners() => Promise<void>

移除本插件的所有监听器（包括网络状态变化的监听）。

自: 1.0.0

---

Interfaces

ConnectionStatus

表示网络连接的状态和类型。

属性	类型	说明	自
connected	boolean	是否存在活跃的网络连接。	1.0.0
connectionType	ConnectionType	当前使用的网络连接类型。如果没有活跃的网络连接，connectionType 将为 'none'。	1.0.0

PluginListenerHandle

属性	类型
remove	() => Promise<void>

Type Aliases

ConnectionType

设备可能拥有的网络连接类型。

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

ConnectionStatusChangeListener

接收状态变更通知的回调函数。

  (status: ConnectionStatus): void