# @algoan/nestjs-google-pubsub-client 中文文档

规范地址：https://npmcn.com/package/%40algoan/nestjs-google-pubsub-client/

版本：0\.5\.0
npm 元数据更新时间：2026-09-24T13:32:44.473Z
中文译文更新时间：2026-11-06T08:18:59.712Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40algoan/nestjs-google-pubsub-client
原文对照：https://npmcn.com/package/%40algoan/nestjs-google-pubsub-client/?lang=original
项目主页：https://github.com/algoan/nestjs-components/tree/master/packages/google-pubsub-client#readme
源码仓库：https://github.com/algoan/nestjs-components

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

- 包体积（解压后）：10.5 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@nestjs/core \>=8，@algoan/pubsub \>=4 \< 7，@nestjs/common \>=8，@nestjs/microservices \>=8，@nestjs/platform-express \>=8
- 首次发布：2020-04-28T14:49:29.195Z
- 最新版本发布：2026-09-24T13:32:44.106Z
- 近 30 天下载量：3908（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：34（近 12 个月 1 个）

## 中文简介

Google Cloud PubSub 的 NestJS 客户端程序

## 安装

```sh
npm install @algoan/nestjs-google-pubsub-client
```

也可以使用：`pnpm add @algoan/nestjs-google-pubsub-client`、`yarn add @algoan/nestjs-google-pubsub-client`、`bun add @algoan/nestjs-google-pubsub-client`

## README

# `google-pubsub-client`

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

⚠️ **此客户端只覆盖 [抽象 `dispatchEvent` 方法](https://github.com/nestjs/nest/blob/master/packages/microservices/client/client-proxy.ts#L80)因此,只有 `client#emit` 方法可以调用.**

## 安装

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

## 使用量

要即时化 GCPubSubClient :

**模块**数字 :

```ts
// 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 {}

```

**服务**数字 :

```typescript
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实例有关的选项。 关于备选方案的更详细情况 [这里](https://github.com/algoan/pubsub#pubsubfactorycreate-transport-options-)

## 常见问题

### @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 和提交记录判断。