AsyncEventEmitter
Defined in: algokit-subscriber-ts/src/types/async-event-emitter.ts:10
Simple asynchronous event emitter class.
Note: This class is not thread-safe.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AsyncEventEmitter():
AsyncEventEmitter
Returns
Section titled “Returns”AsyncEventEmitter
Properties
Section titled “Properties”off: (
eventName,listener) =>AsyncEventEmitter
Defined in: algokit-subscriber-ts/src/types/async-event-emitter.ts:82
Alias for removeListener.
Removes an event listener from the given event.
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string | symbol
The name of the event
listener
Section titled “listener”The listener to remove
Returns
Section titled “Returns”AsyncEventEmitter
The AsyncEventEmitter so you can chain registrations
Methods
Section titled “Methods”emitAsync()
Section titled “emitAsync()”emitAsync(
eventName,event):Promise<void>
Defined in: algokit-subscriber-ts/src/types/async-event-emitter.ts:21
Emit an event and wait for all registered listeners to be run one-by-one in the order they were registered.
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string | symbol
The name of the event
unknown
The event payload
Returns
Section titled “Returns”Promise<void>
on(
eventName,listener):AsyncEventEmitter
Defined in: algokit-subscriber-ts/src/types/async-event-emitter.ts:33
Register an event listener for the given event.
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string | symbol
The name of the event
listener
Section titled “listener”The listener to trigger
Returns
Section titled “Returns”AsyncEventEmitter
The AsyncEventEmitter so you can chain registrations
once()
Section titled “once()”once(
eventName,listener):AsyncEventEmitter
Defined in: algokit-subscriber-ts/src/types/async-event-emitter.ts:45
Register an event listener for the given event that is only fired once.
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string | symbol
The name of the event
listener
Section titled “listener”The listener to trigger
Returns
Section titled “Returns”AsyncEventEmitter
The AsyncEventEmitter so you can chain registrations
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):AsyncEventEmitter
Defined in: algokit-subscriber-ts/src/types/async-event-emitter.ts:63
Removes an event listener from the given event.
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string | symbol
The name of the event
listener
Section titled “listener”The listener to remove
Returns
Section titled “Returns”AsyncEventEmitter
The AsyncEventEmitter so you can chain registrations