跳转至正文
@capgo/capacitor-env 开发者工具 开源

环境 Capacitor 插件

在不同的构建环境中安全地管理环境变量和配置

安装

bun add @capgo/capacitor-env bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-env
  • pnpm add @capgo/capacitor-env
  • yarn add @capgo/capacitor-env

指南

如何在 Capacitor 中使用 Env

使用 @capgo/capacitor-env

Capacitor 插件,用于在原生 code 中访问环境变量

安装

bun add @capgo/capacitor-env
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { Env } from '@capgo/capacitor-env';

API 概览

方法 描述
getKey 根据 key 获取指定环境变量的值。

示例

getKey()

根据 key 获取指定环境变量的值。

import { Env } from '@capgo/capacitor-env';

const result = await Env.getKey({ key: 'API_URL' });
console.log(result.value); // 'https://api.example.com'

完整参考文档

继续阅读 使用 @capgo/capacitor-env

如果你正在使用 使用 @capgo/capacitor-env 要规划原生插件工作,请将其与 @capgo/capacitor-env 以了解 @capgo/capacitor-env 中的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。

常见问题

Env 插件常见问题

如何在 Capacitor 应用中安装 Env 插件?

运行 "bun add @capgo/capacitor-env"(或 "npm install @capgo/capacitor-env"),然后运行 "bunx cap sync" 使 iOS 和 Android 项目同步原生 code。最后在你的应用 code 中从 "@capgo/capacitor-env" 导入即可。

@capgo/capacitor-env 是否支持 React、Vue 和 Angular?

支持。Env 是一个 Capacitor 包,因此它可以与任何在 Capacitor 中运行的 Web 框架配合使用,包括 Ionic、React、Vue、Angular、Svelte 以及原生 JavaScript。

@capgo/capacitor-env 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-env 是免费开源的吗?

是的。code 的源码已在 GitHub 公开,地址为 https://github.com/Cap-go/capacitor-env/,并且你可以通过 npm 免费安装该包。欢迎提交 Bug 报告和 Pull Request。

我能否在无需经过 App Store 审核的情况下,更新使用了 Env 的 code?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App 审核,即可发布 Env 变更

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo