Class EventEmitter<EventTypes, Context>

Minimal EventEmitter interface that is molded against the Node.js EventEmitter interface.

Type Parameters

EventTypes extends ValidEventTypes = string | symbol
Context extends any = any

Hierarchy

EventEmitter
- BaseWalletAdapter

Index

Constructors

constructor

Properties

prefixed

Methods

Constructors

constructor

new EventEmitter<EventTypes, Context>(): Types.Adapter.EventEmitter<EventTypes, Context>

Type Parameters
- EventTypes extends ValidEventTypes = string | symbol
- Context extends unknown = any
Returns Types.Adapter.EventEmitter<EventTypes, Context>

Properties

Static prefixed

prefixed: string | boolean

Methods

addListener

addListener<T>(event: T, fn: EventListener<EventTypes, T>, context?: Context): Types.Adapter.EventEmitter<EventTypes, Context>

- Defined in node_modules/eventemitter3/index.d.ts:45
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: EventListener<EventTypes, T>
- Optional context: Context
Returns Types.Adapter.EventEmitter<EventTypes, Context>

emit

emit<T>(event: T, ...args: Parameters<EventListener<EventTypes, T>>): boolean

- Defined in node_modules/eventemitter3/index.d.ts:32
Calls each of the listeners registered for a given event.

Type Parameters
- T extends string | symbol
Parameters
- event: T
- Rest ...args: Parameters<EventListener<EventTypes, T>>
Returns boolean

eventNames

eventNames(): EventNames<EventTypes>[]

- Defined in node_modules/eventemitter3/index.d.ts:15
Return an array listing the events for which the emitter has registered listeners.

Returns EventNames<EventTypes>[]

listenerCount

listenerCount(event: EventNames<EventTypes>): number

- Defined in node_modules/eventemitter3/index.d.ts:27
Return the number of listeners listening to a given event.

Parameters
- event: EventNames<EventTypes>
Returns number

listeners

listeners<T>(event: T): EventListener<EventTypes, T>[]

- Defined in node_modules/eventemitter3/index.d.ts:20
Return the listeners registered for a given event.

Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns EventListener<EventTypes, T>[]

off

off<T>(event: T, fn?: EventListener<EventTypes, T>, context?: Context, once?: boolean): Types.Adapter.EventEmitter<EventTypes, Context>

- Defined in node_modules/eventemitter3/index.d.ts:69
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: EventListener<EventTypes, T>
- Optional context: Context
- Optional once: boolean
Returns Types.Adapter.EventEmitter<EventTypes, Context>

on

on<T>(event: T, fn: EventListener<EventTypes, T>, context?: Context): Types.Adapter.EventEmitter<EventTypes, Context>

- Defined in node_modules/eventemitter3/index.d.ts:40
Add a listener for a given event.

Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: EventListener<EventTypes, T>
- Optional context: Context
Returns Types.Adapter.EventEmitter<EventTypes, Context>

once

once<T>(event: T, fn: EventListener<EventTypes, T>, context?: Context): Types.Adapter.EventEmitter<EventTypes, Context>

- Defined in node_modules/eventemitter3/index.d.ts:54
Add a one-time listener for a given event.

Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: EventListener<EventTypes, T>
- Optional context: Context
Returns Types.Adapter.EventEmitter<EventTypes, Context>

removeAllListeners

removeAllListeners(event?: EventNames<EventTypes>): Types.Adapter.EventEmitter<EventTypes, Context>

- Defined in node_modules/eventemitter3/index.d.ts:79
Remove all listeners, or those of the specified event.

Parameters
- Optional event: EventNames<EventTypes>
Returns Types.Adapter.EventEmitter<EventTypes, Context>

removeListener

removeListener<T>(event: T, fn?: EventListener<EventTypes, T>, context?: Context, once?: boolean): Types.Adapter.EventEmitter<EventTypes, Context>

- Defined in node_modules/eventemitter3/index.d.ts:63
Remove the listeners of a given event.

Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: EventListener<EventTypes, T>
- Optional context: Context
- Optional once: boolean
Returns Types.Adapter.EventEmitter<EventTypes, Context>

Generated using TypeDoc