# @api3/commons 中文文档

规范地址：https://npmcn.com/package/%40api3/commons/

版本：2\.0\.0
npm 元数据更新时间：2026-08-31T10:14:34.763Z
中文译文更新时间：2026-11-06T10:08:09.196Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：427 kB，205 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.20\.8
- 运行依赖：9 个
- 首次发布：2023-10-09T08:40:13.355Z
- 最新版本发布：2026-08-31T10:14:34.416Z
- 近 30 天下载量：4438（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：28（近 12 个月 4 个）

## 中文简介

> API3项目中常用的公用设施,模块和配置.

## 安装

```sh
npm install @api3/commons
```

也可以使用：`pnpm add @api3/commons`、`yarn add @api3/commons`、`bun add @api3/commons`

## README

# 常识

> API3项目中常用的公用设施,模块和配置.

通俗图书馆意在停止"再发明轮子". 它拥有可以 以其他软件包导入。 这样我们就确保所有软件包都使用相同的逻辑,简化错误修正并避免代码 重叠。 该软件包为交叉平台,可被使用于Node.js和浏览器.

常识库是一个由多个模块组成的集合,每个模块都有自己的README,可以参考.

## 开始

```sh
# Feel free to use your favorite package manager
pnpm i @api3/commons
```

阅读每个模块的文档和来源,如何在项目中使用.

## 模块

-   [块链用途](https://npmcn.com/package/%40api3/commons/src/blockchain-utilities/README.md)
-   [配置 - hash](https://npmcn.com/package/%40api3/commons/src/config-hash/README.md)
-   [配置分隔](https://npmcn.com/package/%40api3/commons/src/config-parsing/README.md)
-   [网页](https://npmcn.com/package/%40api3/commons/src/http/README.md)
-   [日志](https://npmcn.com/package/%40api3/commons/src/logger/README.md)
-   [处理](https://npmcn.com/package/%40api3/commons/src/processing/README.md)
-   [承诺工具](https://npmcn.com/package/%40api3/commons/src/promise-utils/README.md)
-   [释放标记](https://npmcn.com/package/%40api3/commons/src/release-scripts/README.md)
-   [运行中](https://npmcn.com/package/%40api3/commons/src/run-in-loop/README.md)
-   [倾斜](https://npmcn.com/package/%40api3/commons/src/utils/README.md)

## 在普遍背景下使用软件包

有些模块可能只用于浏览器和Node.js上下文,而有些则仅用于Node.js. 为了支持 我们使用不同的切入点。 注意,对只使用浏览器的模块没有支持.

捆绑器或Node.js自动取出正确的切入点,但要记住只有子集模块是 使用通用模块时可用。 如果使用TypeScript,则可能无法取出正确的类型. 你可以设置这些 手动,在您的 `tsconfig.json`数字 :

```json
"compilerOptions": {
  "paths": {
    "@api3/commons": ["./node_modules/@api3/commons/dist/esm/universal-index.d.ts"]
  }
}
```

## 无害环境管理和共同JS

货包载运两个模块系统. `dist/esm` 持有ES模块 `dist/cjs` 持有 CommonJS 模块。 两者 来来来来来来来来来来来来来来来来来来去 捆绑者或Node.js通过 `exports` 字段,所以 `import` 财务报告和审定财务报表 `require` 两者都没有任何配置.

## 相关寄存器

-   [链条](https://github.com/api3dao/chains)
-   [合同](https://github.com/api3dao/contracts)
-   [eslint-plugin-常识](https://github.com/api3dao/eslint-plugin-commons)
-   [欧莎](https://github.com/api3dao/ois)

## 对于开发者

请参看 [开发者指令](https://npmcn.com/package/%40api3/commons/dev-README.md) 详细情况.

## 常见问题

### @api3/commons 是什么？

API3项目中常用的公用设施,模块和配置\.

### 如何安装 @api3/commons？

在项目目录运行 npm install @api3/commons，或使用 pnpm add / yarn add / bun add。

### @api3/commons 支持 TypeScript 吗？

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

### @api3/commons 支持 ESM 还是 CommonJS？

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

### @api3/commons 需要什么版本的 Node\.js？

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

### @api3/commons 可以商用吗？

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

### @api3/commons 的下载量有多少？

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

### @api3/commons 还在维护吗？

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