# @getlarge/nestjs-tools-cluster 中文文档

规范地址：https://npmcn.com/package/%40getlarge/nestjs-tools-cluster/

版本：0\.15\.7
npm 元数据更新时间：2025-01-31T09:56:41.332Z
中文译文更新时间：2026-11-16T06:18:45.153Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40getlarge/nestjs-tools-cluster
原文对照：https://npmcn.com/package/%40getlarge/nestjs-tools-cluster/?lang=original
项目主页：https://github.com/getlarge/nestjs-tools/tree/main/packages/cluster

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

- 包体积（解压后）：24.4 kB，18 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2024-04-16T20:35:46.987Z
- 最新版本发布：2025-01-31T09:56:41.148Z
- 近 30 天下载量：4391（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

集群和工人管理人员

## 安装

```sh
npm install @getlarge/nestjs-tools-cluster
```

也可以使用：`pnpm add @getlarge/nestjs-tools-cluster`、`yarn add @getlarge/nestjs-tools-cluster`、`bun add @getlarge/nestjs-tools-cluster`

## README

# 组

[![npm](https://img.shields.io/npm/v/@getlarge/nestjs-tools-cluster.svg?style=flat)](https://npmjs.org/package/@getlarge/nestjs-tools-cluster)

这个软件包提供了将 NestJS 应用程序集群的简单方法. 这个 `ClusterService` 班级是一个包装 周围的原住民 `cluster` 模块,并提供简单的API来管理工人的生命周期.

## 安装

```bash
npm install --save @getlarge/nestjs-tools-cluster
```

## 示例

```ts
import { Logger } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import { NestFactory } from '@nestjs/core';
import { FastifyAdapter, NestFastifyApplication } from '@nestjs/platform-fastify';
import { ClusterService, ClusterServiceConfig } from '@getlarge/cluster-service';
import { cpus } from 'node:os';

import { AppModule } from './app/app.module';

const GLOBAL_API_PREFIX = 'api';
const DEFAULT_PORT = 3000;
const CLUSTER_MODE = process.env.CLUSTER_MODE === 'true';
const MAX_WORKERS = +process.env.MAX_WORKERS || cpus().length;

async function bootstrap(
  opts: { workerId?: number } = {},
  disconnect: () => void = () => process.exit(1),
): Promise<void> {
  /**
   * This is a global variable that will be used to identify the worker id
   * in the application. This is useful for debugging purposes.
   */
  globalThis.__WORKER_ID__ = opts.workerId;

  try {
    const app = await NestFactory.create<NestFastifyApplication>(
      AppModule,
      new FastifyAdapter({
        trustProxy: true,
        bodyLimit: +process.env.MAX_PAYLOAD_SIZE || 1048576,
      }),
      { bufferLogs: true, abortOnError: false },
    );
    app.setGlobalPrefix(GLOBAL_API_PREFIX);
    const configService = app.get(ConfigService);
    const port = configService.get('PORT', { infer: true }) ?? DEFAULT_PORT;

    await app.listen(port, '0.0.0.0', () => {
      Logger.log(`Listening at http://localhost:${port}/${GLOBAL_API_PREFIX}`);
    });
  } catch (error) {
    Logger.error(error);
    disconnect();
  }
}

if (CLUSTER_MODE) {
  const clusterConfig: ClusterServiceConfig = {
    workers: MAX_WORKERS,
    delay: 2000,
    grace: 1000,
  };

  const clusterService = new ClusterService(clusterConfig);
  clusterService.clusterize(bootstrap).catch((e) => {
    clusterService.logger.error(e);
    process.exit(1);
  });
} else {
  void bootstrap({}, () => {
    process.exit(1);
  });
}
```

## 大楼

运行 `nx build nestjs-tools-cluster` 来建造图书馆.

## 运行单元测试

运行 `nx test nestjs-tools-cluster` 通过 [欢乐](https://jestjs.io/)。 。 。 .

## 常见问题

### @getlarge/nestjs-tools-cluster 是什么？

集群和工人管理人员

### 如何安装 @getlarge/nestjs-tools-cluster？

在项目目录运行 npm install @getlarge/nestjs-tools-cluster，或使用 pnpm add / yarn add / bun add。

### @getlarge/nestjs-tools-cluster 支持 TypeScript 吗？

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

### @getlarge/nestjs-tools-cluster 支持 ESM 还是 CommonJS？

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

### @getlarge/nestjs-tools-cluster 可以商用吗？

@getlarge/nestjs-tools-cluster 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @getlarge/nestjs-tools-cluster 的下载量有多少？

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

### @getlarge/nestjs-tools-cluster 还在维护吗？

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

