agent-core / Exports / IEventEmitterPlugin
Interface: IEventEmitterPlugin
Console-like interface for the EventEmitterPlugin.
Use this interface for typing instead of the concrete EventEmitterPlugin class.
Table of contents
Methods
Methods
on
▸ on(eventType, listener, options?): string
Parameters
| Name | Type |
|---|---|
eventType | TEventName |
listener | TEventEmitterListener |
options? | Object |
options.once? | boolean |
options.filter? | (event: IEventEmitterEventData) => boolean |
Returns
string
Defined in
packages/agent-core/src/plugins/event-emitter/types.ts:149
once
▸ once(eventType, listener, filter?): string
Parameters
| Name | Type |
|---|---|
eventType | TEventName |
listener | TEventEmitterListener |
filter? | (event: IEventEmitterEventData) => boolean |
Returns
string
Defined in
packages/agent-core/src/plugins/event-emitter/types.ts:157
off
▸ off(eventType, handlerIdOrListener): boolean
Parameters
| Name | Type |
|---|---|
eventType | TEventName |
handlerIdOrListener | string | TEventEmitterListener |
Returns
boolean
Defined in
packages/agent-core/src/plugins/event-emitter/types.ts:162
emit
▸ emit(eventType, eventData?): Promise<void>
Parameters
| Name | Type |
|---|---|
eventType | TEventName |
eventData? | Partial<IEventEmitterEventData> |
Returns
Promise<void>