# @falconeta/capacitor-wifi-connect 中文文档

规范地址：https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/

版本：8\.0\.1
npm 元数据更新时间：2026-10-01T16:39:49.174Z
中文译文更新时间：2026-11-14T09:38:07.202Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40falconeta/capacitor-wifi-connect
原文对照：https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/?lang=original
项目主页：https://github.com/falconeta/capacitor-wifi-connect#readme
源码仓库：https://github.com/falconeta/capacitor-wifi-connect

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：98.4 kB，26 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2022-08-05T10:54:35.098Z
- 最新版本发布：2026-10-01T16:39:48.988Z
- 近 30 天下载量：2170（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：49（近 12 个月 4 个）

## 中文简介

用于通过 Wifi 连接设备的插件, 也带有前缀

## 安装

```sh
npm install @falconeta/capacitor-wifi-connect
```

也可以使用：`pnpm add @falconeta/capacitor-wifi-connect`、`yarn add @falconeta/capacitor-wifi-connect`、`bun add @falconeta/capacitor-wifi-connect`

## README

# @falconeta/电容-wifi-连接

## 你喜欢插件吗?

如果你愿意或愿意贡献, 随便给我买杯咖啡吧! 我将感激一切, 即使它是咖啡 或者只是对我的作品的善意评论, 因为这对我很有帮助.

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/falconeta)

## 说明

用于连接设备 trhought Wifi 的插件, 以及前缀

## 安装

```bash
npm install @falconeta/capacitor-wifi-connect
npx cap sync
```

## 示例用途

```typescript
import { CapacitorWifiConnect } from "@falconeta/capacitor-wifi-connect";

  async secureConnect() {
    let { value } = await CapacitorWifiConnect.checkPermission();
    if (value === 'prompt') {
      const data = await CapacitorWifiConnect.requestPermission();
      value = data.value;
    }
    if (value === 'granted') {
      CapacitorWifiConnect.secureConnect({
        ssid: 'SSID',
        password: 'PWD',
      }).then((data) => alert(data.value));
    } else {
      throw new Error('permission denied');
    }
  }
```

# iOS 函数

对于功能,您需要注意以下内容:

-   连接/ 断接只为 iOS11+ 工作
    
-   前缀Connect/securePrefixConnect 只为iOS13+工作
    
-   无法在模拟器中运行, 因此在使用 xCode 构建时需要附加一个实际设备
    
-   将确保您在 XCode 工程中添加“ Hotspot 配置” 和“ Wifi Information ” 功能
    
-   将确保这些许可在信息中描述。 列表
    

```plist
  <key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
  <string>...</string>
  <key>NSLocationAlwaysUsageDescription</key>
  <string>...</string>
  <key>NSLocationWhenInUseUsageDescription</key>
  <string>...</string>
```

## API 密码

-   [`checkPermission()`](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-checkpermission)
-   [`requestPermission()`](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-requestpermission)
-   [`disconnect()`](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-disconnect)
-   [`getSSIDs()`](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-getssids)
-   [`getAppSSID()`](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-getappssid)
-   [`getDeviceSSID()`](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-getdevicessid)
-   [`connect(...)`](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-connect)
-   [`prefixConnect(...)`](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-prefixconnect)
-   [`secureConnect(...)`](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-secureconnect)
-   [`securePrefixConnect(...)`](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-secureprefixconnect)
-   [类型异名](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-type-aliases)
-   [数字](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-enums)

### 检查

```typescript
checkPermission() => Promise<{ value: PermissionState; }>
```

用于检查应用程序是否具有自动化或不使用定位能力的方法.

**回返情况:** `Promise<{ value: [PermissionState](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-permissionstate); }>`

**自:** 1.0.0 (单位:千美元)

* * *

### 请求( )

```typescript
requestPermission() => Promise<{ value: PermissionState; }>
```

(如果授权状况迅速)使用定位能力的自动化方法.

**回返情况:** `Promise<{ value: [PermissionState](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-permissionstate); }>`

**自:** 1.0.0 (单位:千美元)

* * *

### 断开( )

```typescript
disconnect() => Promise<{ value: boolean; }>
```

如果网络被连接到使用一种连接方法,则断开wifi网络的方法.

**回返情况:** `Promise<{ value: boolean; }>`

**自:** 1.0.0 (单位:千美元)

* * *

### 获取SSIDs ()

```typescript
getSSIDs() => Promise<{ value: string[]; status: ConnectState; }>
```

只有安德鲁德 返回应用程序连接的当前 SSID 警告:应用限制为每2分钟4次扫描

**回返情况:** `Promise<{ value: string[]; status: [ConnectState](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-connectstate); }>`

**自:** 5.1.0 国家

* * *

### 获取 AppSSID ()

```typescript
getAppSSID() => Promise<{ value: string; status: ConnectState; }>
```

返回应用程序连接的当前 SSID

**回返情况:** `Promise<{ value: string; status: [ConnectState](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-connectstate); }>`

**自:** 5.1.0 国家

* * *

### 获取DEViceSSID ()

```typescript
getDeviceSSID() => Promise<{ value: string; status: ConnectState; }>
```

iOS QQ 14,Android QQ9: roid

返回设备连接的当前 SSID

**回返情况:** `Promise<{ value: string; status: [ConnectState](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-connectstate); }>`

**自:** 5.1.0 国家

* * *

### 连接(...)

```typescript
connect(options: { ssid: string; saveNetwork?: boolean; }) => Promise<{ value: ConnectState; }>
```

方法试图连接到明确匹配 ssid 参数的wifi 警告(Warning):默认情况下在iOS上启用了已保存的Network,无法禁用由于苹果的bug. ()[https://forums.developer.apple.com/forums/thread/700612 互联网档案馆的存檔,存档日期2014-12-22](https://forums.developer.apple.com/forums/thread/700612)(中文(简体) )

| 参数 | 类型 |
| --- | --- |
| **`options`** | `{ ssid: string; saveNetwork?: boolean; }` |

**回返情况:** `Promise<{ value: [ConnectState](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-connectstate); }>`

**自:** 1.0.0 (单位:千美元)

* * *

### 前缀 Connect (...)

```typescript
prefixConnect(options: { ssid: string; saveNetwork?: boolean; }) => Promise<{ value: ConnectState; }>
```

方法尝试与最近的wifi网络连接,与 ssidPrefix 参数相匹配. 警告(Warning):默认情况下在iOS上启用了已保存的Network,无法禁用由于苹果的bug. ()[https://forums.developer.apple.com/forums/thread/700612 互联网档案馆的存檔,存档日期2014-12-22](https://forums.developer.apple.com/forums/thread/700612)(中文(简体) )

| 参数 | 类型 |
| --- | --- |
| **`options`** | `{ ssid: string; saveNetwork?: boolean; }` |

**回返情况:** `Promise<{ value: [ConnectState](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-connectstate); }>`

**自:** 1.0.0 (单位:千美元)

* * *

### 安全连接(...)

```typescript
secureConnect(options: { ssid: string; password: string; saveNetwork?: boolean; isWep?: boolean; }) => Promise<{ value: ConnectState; }>
```

方法试图连接到明确匹配 ssid 参数的wifi. 如果密码不匹配, 或 IsWep 参数设置不正确, 这将失败 . Android不支持WEP网络. 警告(Warning):默认情况下在iOS上启用了已保存的Network,无法禁用由于苹果的bug. ()[https://forums.developer.apple.com/forums/thread/700612 互联网档案馆的存檔,存档日期2014-12-22](https://forums.developer.apple.com/forums/thread/700612)(中文(简体) )

| 参数 | 类型 |
| --- | --- |
| **`options`** | `{ ssid: string; password: string; saveNetwork?: boolean; isWep?: boolean; }` |

**回返情况:** `Promise<{ value: [ConnectState](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-connectstate); }>`

**自:** 1.0.0 (单位:千美元)

* * *

### 安全前缀Connect(...)

```typescript
securePrefixConnect(options: { ssid: string; password: string; saveNetwork?: boolean; isWep?: boolean; }) => Promise<{ value: ConnectState; }>
```

方法尝试连接到最近的 与 ssidPrefix 参数相匹配的 ssid 前缀的wifi 网络. 如果密码不匹配, 或为Wep 参数, 此选项将失败 设置不正确。 Android不支持WEP网络. 警告(Warning):默认情况下在iOS上启用了已保存的Network,无法禁用由于苹果的bug. ()[https://forums.developer.apple.com/forums/thread/700612 互联网档案馆的存檔,存档日期2014-12-22](https://forums.developer.apple.com/forums/thread/700612)(中文(简体) )

| 参数 | 类型 |
| --- | --- |
| **`options`** | `{ ssid: string; password: string; saveNetwork?: boolean; isWep?: boolean; }` |

**回返情况:** `Promise<{ value: [ConnectState](https://npmcn.com/package/%40falconeta/capacitor-wifi-connect/#readme-connectstate); }>`

**自:** 1.0.0 (单位:千美元)

* * *

### 类型异名

#### 权限状态

`'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'`

### 数字

#### 连接国

| 成员 | 数值 |
| --- | --- |
| **`Ok`** | `0` |
| **`Denied`** | `-1` |
| **`Ko`** | `-2` |
| **`UnknowSsid`** | `-3` |
| **`WifiDisabled`** | `-4` |
| **`AppLocalizationPermission`** | `-5` |
| **`SystemLocalizationPermission`** | `-6` |

## 常见问题

### @falconeta/capacitor-wifi-connect 是什么？

用于通过 Wifi 连接设备的插件, 也带有前缀

### 如何安装 @falconeta/capacitor-wifi-connect？

在项目目录运行 npm install @falconeta/capacitor-wifi-connect，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @falconeta/capacitor-wifi-connect 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @falconeta/capacitor-wifi-connect 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @falconeta/capacitor-wifi-connect 可以商用吗？

@falconeta/capacitor-wifi-connect 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @falconeta/capacitor-wifi-connect 的下载量有多少？

根据 npm 官方下载统计，@falconeta/capacitor-wifi-connect 在 2026/10/14 – 2026/11/12 这 30 天内被下载 2,170 次，日均约 72 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @falconeta/capacitor-wifi-connect 还在维护吗？

最新版本 8\.0\.1 发布于 2026/10/02（1 个月前）；至今共发布 49 个版本，其中过去 12 个月发布了 4 个；首次发布于 2022/08/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

