@capacitor/network

网络 API 提供网络和连接信息。

安装

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);
};

API

• getStatus()
• addListener('networkStatusChange', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

getStatus()

getStatus() => Promise<ConnectionStatus>

查询网络连接的当前状态。

Returns:

Promise<ConnectionStatus>

Since: 1.0.0

---

addListener('networkStatusChange', ...)

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

监听网络连接的更改。

Param	Type
eventName	'networkStatusChange'
listenerFunc	ConnectionStatusChangeListener

Returns:

Promise<PluginListenerHandle>

Since: 1.0.0

---

removeAllListeners()

removeAllListeners() => Promise<void>

删除此插件的所有监听器（包括网络状态更改）。

Since: 1.0.0

---

Interfaces

ConnectionStatus

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

Prop	Type	Description	Since
connected	boolean	是否有活动连接。	1.0.0
connectionType	ConnectionType	当前使用的网络连接类型。如果没有活动网络连接，connectionType 将为 'none'。	1.0.0

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

Type Aliases

ConnectionType

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

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

ConnectionStatusChangeListener

接收状态更改通知的回调。

(status: ConnectionStatus): void