AsyncEventEmitter
@algorandfoundation/algokit-utils / types/async-event-emitter / AsyncEventEmitter
types/async-event-emitter.AsyncEventEmitter
Table of contents
Section titled “Table of contents”Constructors
Section titled “Constructors”Properties
Section titled “Properties”Methods
Section titled “Methods”Constructors
Section titled “Constructors”constructor
Section titled “constructor”• new AsyncEventEmitter(): AsyncEventEmitter
Returns
Section titled “Returns”Properties
Section titled “Properties”listenerMap
Section titled “listenerMap”• Private listenerMap: Record<string | symbol, AsyncEventListener<unknown>[]> = {}
Defined in
Section titled “Defined in”src/types/async-event-emitter.ts:7
listenerWrapperMap
Section titled “listenerWrapperMap”• Private listenerWrapperMap: WeakMap<AsyncEventListener<unknown>, AsyncEventListener<unknown>>
Defined in
Section titled “Defined in”src/types/async-event-emitter.ts:6
• off: (eventName: string | symbol, listener: AsyncEventListener<unknown>) => AsyncEventEmitter
Type declaration
Section titled “Type declaration”▸ (eventName, listener): AsyncEventEmitter
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
eventName | string | symbol |
listener | AsyncEventListener<unknown> |
Returns
Section titled “Returns”Defined in
Section titled “Defined in”src/types/async-event-emitter.ts:55
Methods
Section titled “Methods”emitAsync
Section titled “emitAsync”▸ emitAsync<K>(eventName, event): Promise<void>
Type parameters
Section titled “Type parameters”| Name | Type |
|---|---|
K | extends EventType |
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
eventName | K |
event | EventDataMap[K] |
Returns
Section titled “Returns”Promise<void>
Defined in
Section titled “Defined in”src/types/async-event-emitter.ts:9
▸ emitAsync(eventName, event): Promise<void>
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
eventName | string | symbol |
event | unknown |
Returns
Section titled “Returns”Promise<void>
Defined in
Section titled “Defined in”src/types/async-event-emitter.ts:10
▸ on<K>(eventName, listener): AsyncEventEmitter
Type parameters
Section titled “Type parameters”| Name | Type |
|---|---|
K | extends EventType |
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
eventName | K |
listener | AsyncEventListener<EventDataMap[K]> |
Returns
Section titled “Returns”Defined in
Section titled “Defined in”src/types/async-event-emitter.ts:17
▸ on<T>(eventName, listener): AsyncEventEmitter
Type parameters
Section titled “Type parameters”| Name | Type |
|---|---|
T | unknown |
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
eventName | string | symbol |
listener | AsyncEventListener<T> |
Returns
Section titled “Returns”Defined in
Section titled “Defined in”src/types/async-event-emitter.ts:18
▸ once<K>(eventName, listener): AsyncEventEmitter
Type parameters
Section titled “Type parameters”| Name | Type |
|---|---|
K | extends EventType |
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
eventName | K |
listener | AsyncEventListener<EventDataMap[K]> |
Returns
Section titled “Returns”Defined in
Section titled “Defined in”src/types/async-event-emitter.ts:25
▸ once<T>(eventName, listener): AsyncEventEmitter
Type parameters
Section titled “Type parameters”| Name | Type |
|---|---|
T | unknown |
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
eventName | string | symbol |
listener | AsyncEventListener<T> |
Returns
Section titled “Returns”Defined in
Section titled “Defined in”src/types/async-event-emitter.ts:26
removeListener
Section titled “removeListener”▸ removeListener(eventName, listener): AsyncEventEmitter
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
eventName | string | symbol |
listener | AsyncEventListener<unknown> |