Skip to content

events.Function.createEmitter

github-actions[bot] edited this page Jun 8, 2026 · 2 revisions

@zenstone/ts-utils / events / createEmitter

Function: createEmitter()

createEmitter<E>(): EventsEmitter<E>

Defined in: src/events/index.ts:119

创建事件发射器

  • 同一事件的所有监听器并发执行(Promise.all)
  • on 返回反注册函数
  • 任意监听器抛出时,emit 返回的 Promise 以 AggregateError 拒绝

Type Parameters

E

E extends EventsDefinition = EventsDefinition

Returns

EventsEmitter<E>

Example

type AppEvents = { connect: { id: string }; disconnect: undefined };

const emitter = createEmitter<AppEvents>();

const off = emitter.on('connect', ({ id }) => console.log('connected', id));
await emitter.emit('connect', { id: 'user-1' });
off(); // 取消监听

Clone this wiki locally