# @gravity-ui/nodekit 中文文档

规范地址：https://npmcn.com/package/%40gravity-ui/nodekit/

版本：2\.22\.1
npm 元数据更新时间：2026-11-09T12:01:11.425Z
中文译文更新时间：2026-11-16T23:46:23.300Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：109 kB，53 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：13 个
- peer 依赖：axios ^1\.7\.7
- 首次发布：2023-02-22T13:55:13.374Z
- 最新版本发布：2026-11-09T12:01:11.016Z
- 近 30 天下载量：33098（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：53（近 12 个月 19 个）

## 中文简介

您的节点Js应用程序和脚本的简单工具包

## 安装

```sh
npm install @gravity-ui/nodekit
```

也可以使用：`pnpm add @gravity-ui/nodekit`、`yarn add @gravity-ui/nodekit`、`bun add @gravity-ui/nodekit`

## README

# 节点Kit

NodeKit是用于您Node.js应用程序,脚本和库的简单工具包. 它为日志,遥测,配置和错误处理提供了功能,因此可以在您不同的项目中拥有熟悉的基础.

## 安装

```bash
npm install --save @gravity-ui/nodekit
```

## 开始

在您的工程中添加依赖性 :

```bash
npm install --save @gravity-ui/nodekit
```

然后在您的应用程序中导入并输入节点Kit :

```typescript
import {NodeKit} from '@gravity-ui/nodekit';

const nodeKit = new NodeKit();
nodekit.ctx.log('App is ready');
```

## 文档

见 `docs/` 其他文档目录 :

-   [`docs/configuration.md`](https://github.com/gravity-ui/nodekit/blob/main/docs/configuration.md) 指定您如何配置节点kit本身和基于节点kit的应用程序
-   [`docs/contexts.md`](https://github.com/gravity-ui/nodekit/blob/main/docs/contexts.md) 描述节点Kit上下文、记录和跟踪的概念
-   [`docs/app-error.md`](https://github.com/gravity-ui/nodekit/blob/main/docs/app-error.md) 包含用户为您的应用程序提供的实用自定义错误类描述
-   [`docs/utils.md`](https://github.com/gravity-ui/nodekit/blob/main/docs/utils.md) 列出一些与 NodeKit 捆绑的辅助函数

## 捐款

### 开始

获取节点Kit寄存器和示例应用程序的副本 :

```bash
git clone git@github.com:gravity-ui/nodekit
git clone git@github.com:gravity-ui/nodekit-examples
```

链接您的节点 kit 到 npm 并启动编译器 :

```bash
cd nodekit && npm link && npm run dev
```

然后,在另一个终端,去例,打开你感兴趣的一个, 链接你的节点,然后启动应用程序:

```bash
cd nodekit-examples/basic-app && npm i && npm link @gravity-ui/nodekit
npm run dev
```

此时您可以同时对NodeKit进行修改并演示应用,并实时看到结果.

## 许可证

根据麻省理工学院的许可证分发。 见 [自由主义](https://npmcn.com/package/%40gravity-ui/nodekit/LICENSE) 详细情况.

## 对于人工智能特工

一个由Gravity UI后端共享的基础Node.js工具包(博客、遥测、打出错误、配置、请求语境).

### 何时使用

-   任何希望共享记录、遥测(跟踪)和输入的节点/标语 `AppError`。 。 。 .
-   提供请求范围上下文(日志/跟踪),跨越异域边界.
-   将多种服务集中在同一生态系统中的做法始终如一.

### 不使用时

-   显示 HTTP 路由、 中间软件或服务器, 使用 [`@gravity-ui/expresskit`](https://github.com/gravity-ui/expresskit) ——以NodeKit为顶部并增加了Express/HTTP层.
-   对于一个独立,单文件的脚本,没有日志/遥测需要,平原节点API比完整的NodeKit上下文系统更轻.

### 常见陷阱

-   **幻觉 `import {Logger}` 编号 : `logger`** ——通过节点Kit上下文实现记录: `new NodeKit()` 接下来 `nodekit.ctx.log(...)`,而不是单独的日志导出.
-   **反复证实节点Kit** - 创建一个 `NodeKit` 实例并分享 `ctx`; 创建许多实例来分解记录/遥测配置.
-   **抛出平地 `Error`** - 用捆绑的 `AppError` (见 `docs/app-error.md`)所以误差代码和遥测被一致地捕获.
-   **跳过配置初始化** ——节点Kit读取施工配置;审查 `docs/configuration.md` 在假设默认之前.

## AI代理的文件

安装版本的可代理读取文档位于 `node_modules/@gravity-ui/nodekit/dist/docs/INDEX.md`。 。 。 .

## 常见问题

### @gravity-ui/nodekit 是什么？

您的节点Js应用程序和脚本的简单工具包

### 如何安装 @gravity-ui/nodekit？

在项目目录运行 npm install @gravity-ui/nodekit，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：axios（^1\.7\.7）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gravity-ui/nodekit 支持 TypeScript 吗？

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

### @gravity-ui/nodekit 支持 ESM 还是 CommonJS？

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

### @gravity-ui/nodekit 需要什么版本的 Node\.js？

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

### @gravity-ui/nodekit 可以商用吗？

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

### @gravity-ui/nodekit 的下载量有多少？

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

### @gravity-ui/nodekit 还在维护吗？

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

