AsyncEventEmitter
Defined in: algokit-utils-ts/src/types/async-event-emitter.ts:5
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-utils-ts/src/types/async-event-emitter.ts:55
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string | symbol
listener
Section titled “listener”Returns
Section titled “Returns”AsyncEventEmitter
Methods
Section titled “Methods”emitAsync()
Section titled “emitAsync()”Call Signature
Section titled “Call Signature”emitAsync<
K>(eventName,event):Promise<void>
Defined in: algokit-utils-ts/src/types/async-event-emitter.ts:9
Type Parameters
Section titled “Type Parameters”K extends EventType
Parameters
Section titled “Parameters”eventName
Section titled “eventName”K
EventDataMap[K]
Returns
Section titled “Returns”Promise<void>
Call Signature
Section titled “Call Signature”emitAsync(
eventName,event):Promise<void>
Defined in: algokit-utils-ts/src/types/async-event-emitter.ts:10
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string | symbol
unknown
Returns
Section titled “Returns”Promise<void>
Call Signature
Section titled “Call Signature”on<
K>(eventName,listener):AsyncEventEmitter
Defined in: algokit-utils-ts/src/types/async-event-emitter.ts:17
Type Parameters
Section titled “Type Parameters”K extends EventType
Parameters
Section titled “Parameters”eventName
Section titled “eventName”K
listener
Section titled “listener”AsyncEventListener<EventDataMap[K]>
Returns
Section titled “Returns”AsyncEventEmitter
Call Signature
Section titled “Call Signature”on<
T>(eventName,listener):AsyncEventEmitter
Defined in: algokit-utils-ts/src/types/async-event-emitter.ts:18
Type Parameters
Section titled “Type Parameters”T = unknown
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string | symbol
listener
Section titled “listener”Returns
Section titled “Returns”AsyncEventEmitter
once()
Section titled “once()”Call Signature
Section titled “Call Signature”once<
K>(eventName,listener):AsyncEventEmitter
Defined in: algokit-utils-ts/src/types/async-event-emitter.ts:25
Type Parameters
Section titled “Type Parameters”K extends EventType
Parameters
Section titled “Parameters”eventName
Section titled “eventName”K
listener
Section titled “listener”AsyncEventListener<EventDataMap[K]>
Returns
Section titled “Returns”AsyncEventEmitter
Call Signature
Section titled “Call Signature”once<
T>(eventName,listener):AsyncEventEmitter
Defined in: algokit-utils-ts/src/types/async-event-emitter.ts:26
Type Parameters
Section titled “Type Parameters”T = unknown
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string | symbol
listener
Section titled “listener”Returns
Section titled “Returns”AsyncEventEmitter
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):AsyncEventEmitter
Defined in: algokit-utils-ts/src/types/async-event-emitter.ts:39
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string | symbol
listener
Section titled “listener”Returns
Section titled “Returns”AsyncEventEmitter