Skip to main content

EventsManager

@hyperledger/identus-sdk v8.1.3


@hyperledger/identus-sdk / overview / EventsManager

Class: EventsManager

Defined in: packages/lib/sdk/src/edge-agent/Agent.MessageEvents.ts:11

An extension for the Edge agent that gives it capability of creating listeners for specific events and also emitting or notifying any listener available with the new event.

EventsManager

Constructors​

Constructor​

new EventsManager(): EventsManager

Returns​

EventsManager

Methods​

addListener()​

addListener<T>(eventName: T, callback: EventCallback<T>): number

Defined in: packages/lib/sdk/src/edge-agent/Agent.MessageEvents.ts:23

Just adds a new event listener by passing the event name and the callback function we want to be notified at

Type Parameters​

Type Parameter
T extends ListenerKey

Parameters​

ParameterTypeDescription
eventNameT-
callbackEventCallback<T>-

Returns​

number


emit()​

emit(eventName: ListenerKey, data: any): void

Defined in: packages/lib/sdk/src/edge-agent/Agent.MessageEvents.ts:56

Emit some data to all the listeners of a specific event

Parameters​

ParameterTypeDescription
eventNameListenerKey-
dataany-

Returns​

void


removeListener()​

removeListener<T>(eventName: T, callback: EventCallback<T>): void

Defined in: packages/lib/sdk/src/edge-agent/Agent.MessageEvents.ts:41

Remove an existing event listener, used when the Agent is stopping to make sure no memory leaks are produced

Type Parameters​

Type Parameter
T extends ListenerKey

Parameters​

ParameterTypeDescription
eventNameT-
callbackEventCallback<T>-

Returns​

void