@belongnet/capacitor-pass-to-wallet

中文文档
8.0.4发布于 2026/03/14MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 4105

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

中文使用文档
文档目录20 节
  1. 概览
  2. 快开始
  3. 基本用途
  4. 从基数64添加通行证
  5. 添加本地文件的通行证
  6. 添加多张通行证
  7. 检查是否已经存在过关
  8. 兼容性
  9. 要求(8级)
  10. 参考资料
  11. API 密码
  12. 添加到钱包(...)
  13. 添加多功能切换(...)
  14. 传出(...)
  15. 实验 passExistsById (.)
  16. 实验性( C)
  17. 实验 openPassInWallet (.)
  18. 实验 removePass (.)
  19. 实验 listPasses ()
  20. 接口

@ belonenet/ 电容- pass- to- wallet( 电容)

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

npm downloads

Demo

概览

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

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

快开始

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

基本用途

关于分步骤的教程,参见 添加苹果钱包口 财务报告和审定财务报表 创建苹果钱包通道。 。 。 .

从基数64添加通行证

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

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

添加本地文件的通行证

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

添加多张通行证

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

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

检查是否已经存在过关

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

console.log(result.passExists);

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

兼容性

电容版本插件版本
7.x 电话软件包(v7)
8.x 电话8.x 电话

要求(8级)

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

参考资料

API 密码

添加到钱包(...)

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

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

参数类型
optionsAddToWalletOptions

回返情况: Promise<AddToWalletResult>


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

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

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

参数类型
optionsAddMultipleToWalletOptions

回返情况: Promise<AddToWalletResult>


传出(...)

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

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

参数类型
optionsAddToWalletOptions

回返情况: Promise<PassExistsResult>


实验 passExistsById (.)

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

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

参数类型
optionsPassIdentifierOptions

回返情况: Promise<PassExistsResult>


实验性( C)

_experimental_canAddPasses() => Promise<CanAddPassesResult>

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

回返情况: Promise<CanAddPassesResult>


实验 openPassInWallet (.)

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

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

参数类型
optionsPassIdentifierOptions

回返情况: Promise<OpenPassInWalletResult>


实验 removePass (.)

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

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

参数类型
optionsPassIdentifierOptions

回返情况: Promise<RemovePassResult>


实验 listPasses ()

_experimental_listPasses() => Promise<ListPassesResult>

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

回返情况: Promise<ListPassesResult>


接口

添加到文件夹中

Prop类型说明
valuestring行动状态。 回返 "added" 当传出时.

添加到窗口选项

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

添加多选项

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

传出器

Prop类型说明
passExistsbooleantrue 如果通行证已经用苹果钱包提供.

密码识别选项

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

CanAddPasses 结果

Prop类型说明
canAddPassesbooleantrue 当设备可以显示加到wallet流时.

OpenPass InWallet 最终结果

Prop类型说明
openedbooleantrue 当找到匹配的密码并开始打开操作时.

删除 Pass 保留

Prop类型说明
removedbooleantrue 当匹配的通行证从钱包中移除时.

ListPasses 结果

Prop类型说明
passesWalletPassSummary[]钱包库中目前可见的通行证 .

钱包列表

Prop类型说明
passTypeIdentifierstring钱包通过类型标识符(例如) pass.com.example.membership) (中文(简体) ).
serialNumberstring传出序列号.
organizationNamestring可用时通过的有效载荷的组织名称.

许可证 : 麻省理工学院

版本与发布记录

@belongnet/capacitor-pass-to-wallet 共发布 5 个版本,首次发布于 2026/03/07;过去 12 个月发布了 5 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
8.0.4latest2026/03/147 个月前
8.0.32026/03/147 个月前
8.0.22026/03/107 个月前
8.0.12026/03/078 个月前
8.0.02026/03/078 个月前

关于 @belongnet/capacitor-pass-to-wallet 的常见问题

@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 和提交记录判断。