# @belongnet/capacitor-pass-to-wallet 中文文档

规范地址：https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/

版本：8\.0\.4
npm 元数据更新时间：2026-03-14T00:51:06.324Z
中文译文更新时间：2026-11-07T21:40:35.900Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：70.1 kB，26 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2026-03-06T22:05:19.300Z
- 最新版本发布：2026-03-14T00:51:05.953Z
- 近 30 天下载量：4105（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

允许将.pkpass文件添加到苹果钱包

## 安装

```sh
npm install @belongnet/capacitor-pass-to-wallet
```

也可以使用：`pnpm add @belongnet/capacitor-pass-to-wallet`、`yarn add @belongnet/capacitor-pass-to-wallet`、`bun add @belongnet/capacitor-pass-to-wallet`

## README

# [@ belonenet/ 电容- pass- to- wallet( 电容)](https://github.com/belongnet/capacitor-pass-to-wallet)

要添加的电容插件 `.pkpass` 转到苹果钱包的文件.

[![npm downloads](https://img.shields.io/npm/dm/%40belongnet%2Fcapacitor-pass-to-wallet.svg)](https://www.npmjs.com/package/@belongnet/capacitor-pass-to-wallet)

![Demo](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/demo.gif)

## 概览

添加数 `.pkpass` 使用 Capacitor app 的 Apple 钱包文件 `base64` 内容或本地 `file URI`。 。 。 .

-   `addToWallet` 一次通行证
-   `addMultipleToWallet` 多次通行证
-   `passExists` 检查是否在钱包里有通行证

## 快开始

```bash
bun add @belongnet/capacitor-pass-to-wallet
bunx cap sync
```

## 基本用途

关于分步骤的教程,参见 [添加苹果钱包口](https://ionic.io/docs/tutorials/integrations/digital-passes/apple-wallet-passes/adding) 财务报告和审定财务报表 [创建苹果钱包通道](https://ionic.io/docs/tutorials/integrations/digital-passes/apple-wallet-passes/creating)。 。 。 .

### 从基数64添加通行证

```ts
import { CapacitorPassToWallet } from '@belongnet/capacitor-pass-to-wallet';

await CapacitorPassToWallet.addToWallet({
  base64: passBase64,
});
```

### 添加本地文件的通行证

```ts
import { Filesystem, Directory } from '@capacitor/filesystem';
import { CapacitorPassToWallet } from '@belongnet/capacitor-pass-to-wallet';

const { uri } = await Filesystem.getUri({
  directory: Directory.Cache,
  path: 'passes/example.pkpass',
});

await CapacitorPassToWallet.addToWallet({
  filePath: uri,
});
```

### 添加多张通行证

```ts
// base64 mode
await CapacitorPassToWallet.addMultipleToWallet({
  base64: [base64Pass1, base64Pass2],
});

// file mode
await CapacitorPassToWallet.addMultipleToWallet({
  filePaths: [uri1, uri2],
});
```

### 检查是否已经存在过关

```ts
const result = await CapacitorPassToWallet.passExists({
  filePath: uri,
});

console.log(result.passExists);
```

> \[注\] iOS已实施。 该寄存器中的Android执行目前是一个占位符.

## 兼容性

| 电容版本 | 插件版本 |
| --- | --- |
| 7.x 电话 | [软件包(v7)](https://github.com/atroo/capacitor-pass-to-wallet) |
| 8.x 电话 | 8.x 电话 |

## 要求(8级)

-   `@capacitor/core` `>=8.0.0`
-   iOS 部署目标 : `15.0+`
-   机器人 `minSdkVersion`数字 : `24+`
-   Android 构造默认在此插件中 : `compileSdkVersion 36`, (中文(简体) ), `targetSdkVersion 36`,爪哇语 `21`

## 参考资料

-   **[atroo/capor-pass-to-wallet(电容器)](https://github.com/atroo/capacitor-pass-to-wallet)** —— 7. Capacitor 7.x分叉 (中文(简体) )`@atroo/capacitor-pass-to-wallet`) (中文(简体) ).
-   **[NitnelavAH/电容器接地](https://github.com/NitnelavAH/capacitor-pass-to-wallet)** ——原插件(Capacitor 4–7).

## API 密码

-   [`addToWallet(...)`](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-addtowallet)
-   [`addMultipleToWallet(...)`](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-addmultipletowallet)
-   [`passExists(...)`](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-passexists)
-   [`_experimental_passExistsById(...)`](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-_experimental_passexistsbyid)
-   [`_experimental_canAddPasses()`](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-_experimental_canaddpasses)
-   [`_experimental_openPassInWallet(...)`](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-_experimental_openpassinwallet)
-   [`_experimental_removePass(...)`](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-_experimental_removepass)
-   [`_experimental_listPasses()`](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-_experimental_listpasses)
-   [接口](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-interfaces)

### 添加到钱包(...)

```typescript
addToWallet(options: AddToWalletOptions) => Promise<AddToWalletResult>
```

打开 Apple 钱包单张 `.pkpass`。 。 。 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[AddToWalletOptions](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-addtowalletoptions)` |

**回返情况:** `Promise<[AddToWalletResult](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-addtowalletresult)>`

* * *

### 添加多功能切换(...)

```typescript
addMultipleToWallet(options: AddMultipleToWalletOptions) => Promise<AddToWalletResult>
```

打开多个苹果钱包工作表 `.pkpass` 文档.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[AddMultipleToWalletOptions](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-addmultipletowalletoptions)` |

**回返情况:** `Promise<[AddToWalletResult](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-addtowalletresult)>`

* * *

### 传出(...)

```typescript
passExists(options: AddToWalletOptions) => Promise<PassExistsResult>
```

检查 Apple 钱包中是否已经存在过关 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[AddToWalletOptions](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-addtowalletoptions)` |

**回返情况:** `Promise<[PassExistsResult](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-passexistsresult)>`

* * *

### 实验 passExistsById (.)

```typescript
_experimental_passExistsById(options: PassIdentifierOptions) => Promise<PassExistsResult>
```

检查是否通过标识符和可选序列号存在.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[PassIdentifierOptions](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-passidentifieroptions)` |

**回返情况:** `Promise<[PassExistsResult](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-passexistsresult)>`

* * *

### 实验性( C)

```typescript
_experimental_canAddPasses() => Promise<CanAddPassesResult>
```

返回设备是否可以添加通行证 .

**回返情况:** `Promise<[CanAddPassesResult](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-canaddpassesresult)>`

* * *

### 实验 openPassInWallet (.)

```typescript
_experimental_openPassInWallet(options: PassIdentifierOptions) => Promise<OpenPassInWalletResult>
```

以标识符打开 Apple 钱包中已有的通道 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[PassIdentifierOptions](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-passidentifieroptions)` |

**回返情况:** `Promise<[OpenPassInWalletResult](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-openpassinwalletresult)>`

* * *

### 实验 removePass (.)

```typescript
_experimental_removePass(options: PassIdentifierOptions) => Promise<RemovePassResult>
```

通过标识符从 Apple 钱包中删除已有的密码.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[PassIdentifierOptions](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-passidentifieroptions)` |

**回返情况:** `Promise<[RemovePassResult](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-removepassresult)>`

* * *

### 实验 listPasses ()

```typescript
_experimental_listPasses() => Promise<ListPassesResult>
```

列表钱包通过可见的应用程序 .

**回返情况:** `Promise<[ListPassesResult](https://npmcn.com/package/%40belongnet/capacitor-pass-to-wallet/#readme-listpassesresult)>`

* * *

### 接口

#### 添加到文件夹中

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`value`** | `string` | 行动状态。 回返 `"added"` 当传出时. |

#### 添加到窗口选项

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`base64`** | `string` | 基础64编码 `.pkpass` 文件内容。 何时可选 `filePath` 提供. |
| **`filePath`** | `string` | 本地文件路径/ URI 到 a `.pkpass` 文件(例如来自 `Filesystem.getUri`) (中文(简体) ). 何时可选 `base64` 提供. |

#### 添加多选项

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`base64`** | `string[]` | 基准64编码列表 `.pkpass` 文件内容。 何时可选 `filePaths` 提供. |
| **`filePaths`** | `string[]` | 本地文件路径列表/ URIs to `.pkpass` 文档。 何时可选 `base64` 提供. |

#### 传出器

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`passExists`** | `boolean` | `true` 如果通行证已经用苹果钱包提供. |

#### 密码识别选项

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`passTypeIdentifier`** | `string` | 钱包通过类型标识符(例如) `pass.com.example.membership`) (中文(简体) ). |
| **`serialNumber`** | `string` | 可选的序列号以瞄准特定的通过实例. |

#### CanAddPasses 结果

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`canAddPasses`** | `boolean` | `true` 当设备可以显示加到wallet流时. |

#### OpenPass InWallet 最终结果

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`opened`** | `boolean` | `true` 当找到匹配的密码并开始打开操作时. |

#### 删除 Pass 保留

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`removed`** | `boolean` | `true` 当匹配的通行证从钱包中移除时. |

#### ListPasses 结果

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`passes`** | `WalletPassSummary[]` | 钱包库中目前可见的通行证 . |

#### 钱包列表

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`passTypeIdentifier`** | `string` | 钱包通过类型标识符(例如) `pass.com.example.membership`) (中文(简体) ). |
| **`serialNumber`** | `string` | 传出序列号. |
| **`organizationName`** | `string` | 可用时通过的有效载荷的组织名称. |

* * *

**许可证 :** 麻省理工学院

## 常见问题

### @belongnet/capacitor-pass-to-wallet 是什么？

允许将\.pkpass文件添加到苹果钱包

### 如何安装 @belongnet/capacitor-pass-to-wallet？

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

### @belongnet/capacitor-pass-to-wallet 支持 TypeScript 吗？

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

### @belongnet/capacitor-pass-to-wallet 支持 ESM 还是 CommonJS？

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

### @belongnet/capacitor-pass-to-wallet 可以商用吗？

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

### @belongnet/capacitor-pass-to-wallet 的下载量有多少？

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

### @belongnet/capacitor-pass-to-wallet 还在维护吗？

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