@getlarge/nestjs-tools-cluster

中文文档
0.15.7发布于 2025/01/31Apache-2.0TypeScriptCommonJS近 30 天下载 4391

Cluster and workers manager

原始使用文档
文档目录4 节
  1. Installation
  2. Example
  3. Building
  4. Running unit tests

Cluster

npm

This package provides a simple way to clusterize a NestJS application. The ClusterService class is a wrapper around the native cluster module and provides a simple API to manage the workers' lifecycle.

Installation

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

Example

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);
  });
}

Building

Run nx build nestjs-tools-cluster to build the library.

Running unit tests

Run nx test nestjs-tools-cluster to execute the unit tests via Jest.

版本与发布记录

@getlarge/nestjs-tools-cluster 共发布 2 个版本,首次发布于 2024/04/17;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.15.7latest2025/01/311.8 年前
0.15.62024/04/172 年前

关于 @getlarge/nestjs-tools-cluster 的常见问题

@getlarge/nestjs-tools-cluster 是什么?

Cluster and workers manager

如何安装 @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 和提交记录判断。