Skip to content

events.Interface.EventsEmitter

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

@zenstone/ts-utils / events / EventsEmitter

Interface: EventsEmitter<E>

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

事件发射器接口

on 返回反注册函数,无需持有 callback 引用即可取消监听。

Type Parameters

E

E extends EventsDefinition = EventsDefinition

Methods

emit()

emit<N>(name, params): Promise<void>

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

Type Parameters

N

N extends string | number | symbol

Parameters

name

N

params

E[N]

Returns

Promise<void>


off()

off<N>(name, callback): void

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

Type Parameters

N

N extends string | number | symbol

Parameters

name

N

callback

EventCallbackFn<E[N]>

Returns

void


on()

on<N>(name, callback): EventUnsubscribeFn

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

Type Parameters

N

N extends string | number | symbol

Parameters

name

N

callback

EventCallbackFn<E[N]>

Returns

EventUnsubscribeFn

Clone this wiki locally