# @bullstudio/nestjs 中文文档

规范地址：https://npmcn.com/package/%40bullstudio/nestjs/

版本：2\.5\.4
npm 元数据更新时间：2026-10-27T19:59:48.977Z
中文译文更新时间：2026-11-08T19:33:08.514Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：9.4 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：2 个
- peer 依赖：express ^5\.0\.0，fastify ^5\.10\.0，@nestjs/core ^11\.0\.0，@nestjs/common ^11\.0\.0
- 首次发布：2026-06-01T13:42:17.016Z
- 最新版本发布：2026-10-27T19:59:48.628Z
- 近 30 天下载量：6179（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

雀巢JS框架适配器,用于Bulstudio嵌入模式.

## 安装

```sh
npm install @bullstudio/nestjs
```

也可以使用：`pnpm add @bullstudio/nestjs`、`yarn add @bullstudio/nestjs`、`bun add @bullstudio/nestjs`

## README

# @bullstudio/nestjs (英语)

雀巢JS框架适配器,用于Bulstudio嵌入模式.

## 安装

```sh
pnpm add @bullstudio/nestjs @bullstudio/bullmq-adapter
```

安装您已经使用的 Nest 平台 :

```sh
pnpm add @nestjs/common @nestjs/core @nestjs/platform-express
```

或:

```sh
pnpm add @nestjs/common @nestjs/core @nestjs/platform-fastify
```

## 用于RootAsync

使用 `forRootAsync()` 当队列由巢穴依赖注射提供时. 通过任何导出注入队列提供者的模块 `imports`。 。 。 .

```ts
import { createBullMqQueueAdapter } from "@bullstudio/bullmq-adapter";
import { BullstudioModule } from "@bullstudio/nestjs";
import { getQueueToken } from "@nestjs/bullmq";
import { Module } from "@nestjs/common";
import type { Queue } from "bullmq";

@Module({
  imports: [
    BullstudioModule.forRootAsync({
      imports: [QueueModule],
      inject: [getQueueToken("email")],
      useFactory: (emailQueue: Queue) => ({
        mountPath: "/ops/bullstudio",
        queues: [
          createBullMqQueueAdapter(emailQueue, {
            key: "email",
            label: "Email",
          }),
        ],
        readOnly: true,
      }),
    }),
  ],
})
export class AppModule {}
```

## 旋转

使用 `forRoot()` 当队列适配器可以直接创建时.

```ts
import { createBullMqQueueAdapter } from "@bullstudio/bullmq-adapter";
import { BullstudioModule } from "@bullstudio/nestjs";
import { Module } from "@nestjs/common";
import { Queue } from "bullmq";

const emailQueue = new Queue("email");

@Module({
  imports: [
    BullstudioModule.forRoot({
      mountPath: "/ops/bullstudio",
      queues: [
        createBullMqQueueAdapter(emailQueue, {
          key: "email",
          label: "Email",
        }),
      ],
      protection: {
        type: "basic",
        username: process.env.BULLSTUDIO_USERNAME ?? "operator",
        password: process.env.BULLSTUDIO_PASSWORD ?? "change-me",
      },
    }),
  ],
})
export class AppModule {}
```

`mountPath` 是公共仪表板 URL。 它直接挂在.. 基础快报或快报服务器,独立于 `app.setGlobalPrefix()`。 。 。 .

嵌入模式只显示配置中提供的队列适配器 . Bullstudio不创建队列,注册处理器,或自有队列生命周期.

## 常见问题

### @bullstudio/nestjs 是什么？

雀巢JS框架适配器,用于Bulstudio嵌入模式\.

### 如何安装 @bullstudio/nestjs？

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

### @bullstudio/nestjs 支持 TypeScript 吗？

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

### @bullstudio/nestjs 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @bullstudio/nestjs 需要什么版本的 Node\.js？

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

### @bullstudio/nestjs 可以商用吗？

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

### @bullstudio/nestjs 的下载量有多少？

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

### @bullstudio/nestjs 还在维护吗？

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