# @eggjs/eventbus-decorator 中文文档

规范地址：https://npmcn.com/package/%40eggjs/eventbus-decorator/

版本：4\.1\.0
npm 元数据更新时间：2026-10-07T08:22:26.460Z
中文译文更新时间：2026-11-13T09:23:50.355Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40eggjs/eventbus-decorator
原文对照：https://npmcn.com/package/%40eggjs/eventbus-decorator/?lang=original
项目主页：https://github.com/eggjs/egg/tree/next/tegg/core/eventbus-decorator
源码仓库：https://github.com/eggjs/egg

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

- 包体积（解压后）：11.3 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：3 个
- 首次发布：2021-07-22T08:53:18.925Z
- 最新版本发布：2026-10-07T08:22:26.119Z
- 近 30 天下载量：6243（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：255（近 12 个月 104 个）

## 中文简介

tegg 事件调制器

## 安装

```sh
npm install @eggjs/eventbus-decorator
```

也可以使用：`pnpm add @eggjs/eventbus-decorator`、`yarn add @eggjs/eventbus-decorator`、`bun add @eggjs/eventbus-decorator`

## README

# `@eggjs/eventbus-decorator`

[![NPM version](https://img.shields.io/npm/v/@eggjs/eventbus-decorator.svg?style=flat-square)](https://npmjs.org/package/@eggjs/eventbus-decorator) [![Known Vulnerabilities](https://snyk.io/test/npm/@eggjs/eventbus-decorator/badge.svg?style=flat-square)](https://snyk.io/test/npm/@eggjs/eventbus-decorator) [![npm download](https://img.shields.io/npm/dm/@eggjs/eventbus-decorator.svg?style=flat-square)](https://npmjs.org/package/@eggjs/eventbus-decorator) [![Node.js Version](https://img.shields.io/node/v/@eggjs/eventbus-decorator.svg?style=flat)](https://nodejs.org/en/download/)

## 使用量

### 发射事件

```ts
import { EventBus } from '@eggjs/eventbus-decorator';

// Define event first.
// Ts can check event and args type for you.
declare module '@eggjs/eventbus-decorator' {
  interface Events {
    hello: (msg: string) => Promise<void>;
  }
}

class Foo {
  @Inject()
  private readonly eventBus: EventBus;

  bar() {
    this.eventBus.emit('hello', '01');
  }
}
```

### 软体事件

在记忆中缓存事件直到解锁.

```ts
class Foo {
  @Inject()
  private readonly eventBus: ContextEventBus;

  bar() {
    this.eventBus.cork();
    // ...do something
    this.eventBus.emit('hello', '01');
    // ...do other things

    // emit all cached events
    this.eventBus.uncork();
  }
}
```

### 处理事件

```ts
@Event('hello')
export class Foo {
  async handle(msg: string): Promise<void> {
    console.log('msg: ', msg);
  }
}
```

### 处理多个事件

```ts
@Event('hello')
@Event('hi')
export class Foo {
  async handle(msg: string): Promise<void> {
    console.log('msg: ', msg);
  }
}
```

### 插入事件上下文

如果您想知道正在处理哪个事件,请输入事件上下文. 上下文参数必须是第一个参数

```ts
@Event('hello')
@Event('hi')
export class Foo {
  async handle(@EventContext() ctx: IEventContext, msg: string): Promise<void> {
    console.log('eventName: ', ctx.eventName);
    console.log('msg: ', msg);
  }
}
```

## 常见问题

### @eggjs/eventbus-decorator 是什么？

tegg 事件调制器

### 如何安装 @eggjs/eventbus-decorator？

在项目目录运行 npm install @eggjs/eventbus-decorator，或使用 pnpm add / yarn add / bun add。

### @eggjs/eventbus-decorator 支持 TypeScript 吗？

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

### @eggjs/eventbus-decorator 支持 ESM 还是 CommonJS？

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

### @eggjs/eventbus-decorator 需要什么版本的 Node\.js？

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

### @eggjs/eventbus-decorator 可以商用吗？

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

### @eggjs/eventbus-decorator 的下载量有多少？

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

### @eggjs/eventbus-decorator 还在维护吗？

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