Class FreeSwitchEventEmitter<E, T>

Inspired by https://danilafe.com/blog/typescript_typesafe_events/ but using Map, Set, adding once and an async version. typed-emitter no longer works properly.

Type Parameters

E extends string
T extends Record<E, (arg: never) => void>

Hierarchy (View Summary)

FreeSwitchEventEmitter
- FreeSwitchResponse

Index

Constructors

Methods

emit on once onceAsync removeAllListeners removeListener

Constructors

constructor

new FreeSwitchEventEmitter<
    E extends string,
    T extends Record<E, (arg: never) => void>,
>(
    registerEvent?: (event: keyof T) => void,
    unregisterEvent?: (event: keyof T) => void,
): FreeSwitchEventEmitter<E, T>
Constructs a new event emitter.
```
const ev = new FreeSwitchEventEmitter<'ping',{ ping: () => console.log('ping\) }>()
```
Type Parameters
- E extends string
- T extends Record<E, (arg: never) => void>
Parameters
- OptionalregisterEvent: (event: keyof T) => void
- OptionalunregisterEvent: (event: keyof T) => void
Returns FreeSwitchEventEmitter<E, T>
- Defined in src/event-emitter.ts:19

Methods

emit

emit<K extends string | number | symbol>(
event: K,
arg: Parameters<T[K]>[0],
): boolean
Send out an event: all registered callbacks are notified.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- arg: Parameters<T[K]>[0]
Returns boolean
- Defined in src/event-emitter.ts:30

on

on<K extends string | number | symbol>(event: K, handler: T[K]): this
Register a new callback for the named event. The callback is called every time the event is emitted.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- handler: T[K]
Returns this
- Defined in src/event-emitter.ts:48

once

once<K extends string | number | symbol>(event: K, handler: T[K]): this
Register a new callback for the named event. The callback is only called the first time the event is emitted.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- handler: T[K]
Returns this
- Defined in src/event-emitter.ts:64

onceAsync

onceAsync<K extends string | number | symbol>(
event: K,
): Promise<Parameters<T[K]>>
Returns a Promise that is resolved the next time the named event is emitted.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
Returns Promise<Parameters<T[K]>>
- Defined in src/event-emitter.ts:79

removeAllListeners

removeAllListeners(): void
Unregisters all callbacks from the named event.

Returns void
- Defined in src/event-emitter.ts:103

removeListener

removeListener<K extends string | number | symbol>(
event: K,
handler: T[K],
): void
Unregister the callback from the named event.
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- handler: T[K]
Returns void
- Defined in src/event-emitter.ts:91