@algoan/nestjs-google-pubsub-client

中文文档
0.5.0发布于 2026/09/24ISCTypeScriptCommonJS零依赖构建来源已验证近 30 天下载 3908

Google Cloud PubSub 的 NestJS 客户端程序

中文使用文档
文档目录3 节
  1. 安装
  2. 使用量
  3. new GCPubSubClient(options)

google-pubsub-client

客户端扩展了客户端Proxy类,并需要使用@algoan/pubsub来推翻放出方法.

⚠️ 此客户端只覆盖 抽象 dispatchEvent 方法因此,只有 client#emit 方法可以调用.

安装

npm install --save @algoan/pubsub @algoan/nestjs-google-pubsub-client

使用量

要即时化 GCPubSubClient :

模块数字 :

// app.module.ts
import { Module } from '@nestjs/common';

import { GCPubSubClient } from '../../src';
import { AppController } from './app.controller';
import { AppService } from './app.service';

/**
 * App module
 */
@Module({
  controllers: [AppController],
  providers: [
    AppService,
    {
      provide: 'PUBSUB_CLIENT',
      useFactory: () => {
        // Use a factory to add you custom options
        return new GCPubSubClient({});
      },
    },
  ],
})
export class AppModule {}

服务数字 :

import { Inject, OnModuleInit } from '@nestjs/common';
import { ClientProxy } from '@nestjs/microservices';

/**
 * Fake app service
 */
export class AppService implements OnModuleInit {
  constructor(@Inject('PUBSUB_CLIENT') private readonly client: ClientProxy) {}

  /**
   * Connect the client proxy on module init
   * NOTE: this is optional with GooglePubSubClient. It is called anyway in the emit method
   * See https://github.com/nestjs/nest/blob/master/packages/microservices/client/client-proxy.ts#L67
   */
  public async onModuleInit(): Promise<void> {
    await this.client.connect();
  }
  /**
   * Emit a test event
   * @param data Payload sent
   */
  public emitTestEvent(data: { hello: string }): void {
    this.client.emit('test_event', data);
  }
}

new GCPubSubClient(options)

启动新的 Google Cloud PubSub 客户端代理 .

  • options: 与GC PubSub实例有关的选项。 关于备选方案的更详细情况 这里

版本与发布记录

@algoan/nestjs-google-pubsub-client 共发布 34 个版本,首次发布于 2020/04/28;过去 12 个月发布了 1 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.5.0latest2026/09/241 个月前
0.4.132025/06/111.4 年前
0.4.122024/09/162 年前
0.4.112023/12/112 年前
0.4.102023/11/102 年前
0.4.92023/06/173 年前

关于 @algoan/nestjs-google-pubsub-client 的常见问题

@algoan/nestjs-google-pubsub-client 是什么?

Google Cloud PubSub 的 NestJS 客户端程序

如何安装 @algoan/nestjs-google-pubsub-client?

在项目目录运行 npm install @algoan/nestjs-google-pubsub-client,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@nestjs/core(>=8)、@algoan/pubsub(>=4 < 7)、@nestjs/common(>=8)、@nestjs/microservices(>=8)、@nestjs/platform-express(>=8)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@algoan/nestjs-google-pubsub-client 支持 TypeScript 吗?

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

@algoan/nestjs-google-pubsub-client 支持 ESM 还是 CommonJS?

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

@algoan/nestjs-google-pubsub-client 可以商用吗?

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

@algoan/nestjs-google-pubsub-client 的下载量有多少?

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

@algoan/nestjs-google-pubsub-client 还在维护吗?

最新版本 0.5.0 发布于 2026/09/24(1 个月前);至今共发布 34 个版本,其中过去 12 个月发布了 1 个;首次发布于 2020/04/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。