@adobe/aio-lib-core-config

中文文档
5.0.1发布于 2024/02/12Apache-2.0CommonJS近 30 天下载 11.1万

Adobe I/O 配置模块

中文使用文档
文档目录8 节
  1. 持久文件位置
  2. 用户配置
  3. 项目配置
  4. Dot 信封配置
  5. 解析值
  6. 探索
  7. 捐款
  8. 许可证发放

@adobe/aio-lib-core-config

Version Downloads/week Node.js CI License Codecov Coverage Size(minified)

这是一个节点模块,用于管理持久性和环境可变配置.

模块可以添加到您的项目中:

npm install @adobe/aio-lib-core-config --save

这是片段:

const config = require('@adobe/aio-lib-core-config')

// set a key value
config.set('pgb.authtoken', 1234)

// reload data from files and environmental variables
config.reload()

// get all stored data
config.get()

// get data from a given key
config.get('pgb.authtoken')

// delete a key
config.delete('pgb.authtoken')

持久文件位置

用户配置

用户默认位置为:

  1. ENV ['AIO CONFIG FILE'] (法语)
  2. ENV ['XDG CONFIG HOME']/aio (韩语)
  3. <HOME>/.config/aio> (英语)

取决于指定的环境变量是否存在

项目配置

本地配置从 美元/.aio

Dot 信封配置

本地 . env 文件也被装入 。 此文件可以包含环境变量.

注:所有环境可变名称会转换为大写.

  1. 如果存在重复的环境变量,如果大写版本存在,就会被提升.
aa=1 
aA=2
AA=3 <-- Hoisted as AA
  1. 如果环境变量重复,且有多种情况变化,则会将第一个条目提上架.
aa=1 <-- Hoisted as AA
Aa=2

解析值

解析配置分两步进行:

  1. .env 文件读取,解析并悬挂到环境变量(process.env)
  2. 用户和本地文件被读取

继承与国家预防机制类似,可以使用用户文件,项目文件以及匹配的环境变量来设定. 数值按以下顺序读取并合并,以提升优先级: 1

  1. 用户配置 gb.~/.config/aio
  2. 项目配置,如: $PWD/.aio
  3. 环境变量匹配 AIO-PLUGIN-KEY >
$ AIO_PGB_AUTHTOKEN=1234 node
> config.get('pgb.authtoken')
1234

$ AIO_PGB_AUTH__TOKEN=1234 node # use double underscores to specify an underscore
> config.get('pgb.auth_token')
1234

探索

goto API 密码

捐款

欢迎捐款! 读取 贡献指南 更多信息.

许可证发放

这个项目根据Apache V2许可证获得许可. 见 自由主义 更多信息.

版本与发布记录

@adobe/aio-lib-core-config 共发布 20 个版本,首次发布于 2019/09/17;过去 12 个月发布了 0 个版本。

版本发布日期距今
5.0.1latest2024/02/122 年前
5.0.02024/01/102 年前
4.0.0-pre.2024-01-08.d04a66d9next2024/01/082 年前
4.0.02023/07/063 年前
3.1.02023/01/243 年前
3.0.02022/08/194 年前

关于 @adobe/aio-lib-core-config 的常见问题

@adobe/aio-lib-core-config 是什么?

Adobe I/O 配置模块

如何安装 @adobe/aio-lib-core-config?

在项目目录运行 npm install @adobe/aio-lib-core-config,或使用 pnpm add / yarn add / bun add。

@adobe/aio-lib-core-config 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/adobe__aio-lib-core-config 是否存在。

@adobe/aio-lib-core-config 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@adobe/aio-lib-core-config 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@adobe/aio-lib-core-config 可以商用吗?

@adobe/aio-lib-core-config 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@adobe/aio-lib-core-config 的下载量有多少?

根据 npm 官方下载统计,@adobe/aio-lib-core-config 在 2026/10/05 – 2026/11/03 这 30 天内被下载 111,127 次,日均约 3,704 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@adobe/aio-lib-core-config 还在维护吗?

最新版本 5.0.1 发布于 2024/02/12(2 年前);至今共发布 20 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/09/17。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。