# @eropple/nestjs-correlation-id 中文文档

规范地址：https://npmcn.com/package/%40eropple/nestjs-correlation-id/

版本：1\.0\.1
npm 元数据更新时间：2025-09-06T03:14:41.321Z
中文译文更新时间：2026-11-14T00:00:20.833Z
软件包许可：MIT

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

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

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 包体积（解压后）：78.7 kB，23 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- peer 依赖：rxjs \>=6\.4\.0，@nestjs/common \>=6\.0\.0
- 首次发布：2019-05-21T05:27:48.051Z
- 最新版本发布：2019-05-29T00:27:13.296Z
- 近 30 天下载量：2785（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

用于管理 NestJS(或任何其他Express app)中的X-Correlation-ID头的中端软件.

## 安装

```sh
npm install @eropple/nestjs-correlation-id
```

也可以使用：`pnpm add @eropple/nestjs-correlation-id`、`yarn add @eropple/nestjs-correlation-id`、`bun add @eropple/nestjs-correlation-id`

## README

# `@eropple/nestjs-correlation-id`

这个软件包中包含一个单一的全局性中间软件,运行在 `X-Correlation-Id` 头曰. 如果在收到的请求中不存在,它就 生成随机的 UUID 并将其附加到 `X-Correlation-Id` 标题 请求(`http.IncomingMessage`)和反应(`http.ServerResponse`(中文(简体) ) 请求管道。 如果它已经存在,则存在 值被复制到响应头.

不像其他软件包做同样的事情,这个 _没有_ 允许您更改 标题。 那是因为其他包裹在我的 `@eropple/nestjs-*` 生态系统依赖 `X-Correlation-Id` 并打算用于 和他们一起... 如果你不去用的话 `@eropple/nestjs-data-sec` 或者说 `@eropple/nestjs-auth`你可能不在乎 但几乎每个人都用 `X-Correlation-Id` 或者说 `X-Request-Id`所以这对你还是有用的.

这是用快递测试的,因为它是中间的软件 它可能不会工作 斋戒. 如果有人想要添加快取版本, 拉请求是 感谢接受.

## 安装

`yarn install @eropple/nestjs-correlation-id`

## 使用量

将此添加为 _第一个_ 位于您全球中枢软件链中的中枢软件。 (那边, 之后的任何东西, 喜欢

```ts
import { CorrelationIdMiddleware } from "@eropple/nestjs-correlation-id";

async function init() {
  const app: INestApplication = /* ... */

  app.use(CorrelationIdMiddleware());
  /* add other middleware, interceptors, etc. */

  await app.listen(3000);
}
```

默认使用 `uuid/v4` 生成一个值,但你可以做任何事情 你想通过一个 `() => string` 函数。 UUID 往往最强 共同的选择,虽然.

## 常见问题

### @eropple/nestjs-correlation-id 是什么？

用于管理 NestJS\(或任何其他Express app\)中的X-Correlation-ID头的中端软件\.注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @eropple/nestjs-correlation-id？

在项目目录运行 npm install @eropple/nestjs-correlation-id，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：rxjs（\>=6\.4\.0）、@nestjs/common（\>=6\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @eropple/nestjs-correlation-id 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/eropple\_\_nestjs-correlation-id 是否存在。

### @eropple/nestjs-correlation-id 支持 ESM 还是 CommonJS？

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

### @eropple/nestjs-correlation-id 可以商用吗？

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

### @eropple/nestjs-correlation-id 的下载量有多少？

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

### @eropple/nestjs-correlation-id 还在维护吗？

最新版本 1\.0\.1 发布于 2019/05/29（7 年前）；至今共发布 2 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/05/21。作者已将其标记为弃用，新项目建议寻找替代方案。