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