Class TypedEvent<T>

Event emitter class that handles typed events.

TypedEvent

Type Parameters

T

Implements

Disposable

Index

Constructors

Methods

[dispose] emit off on once pipe removeAllListeners

Constructors

constructor

new TypedEvent<T>(): TypedEvent<T>
Type Parameters
- T
Returns TypedEvent<T>

Methods

[dispose]

"[dispose]"(): void
Returns void
Implementation of Disposable.[dispose]
- Defined in utils/TypedEvent.ts:32

emit

emit(event: T): Promise<void>
Calls the registered event handler listener functions on after the other. The order in which the functions are called is not defined.
Parameters
- event: T
  The typed event parameter that will be provided to each listener.
Returns Promise<void>
- Defined in utils/TypedEvent.ts:88

off

off(listener: Listener<T>): void
Removes a listener function from an event emitter. If it is called from inside an event handler the current event will still call the removed handler if it wasn't called so far.
Parameters
- listener: Listener<T>
  Function that should be removed.
Returns void
- Defined in utils/TypedEvent.ts:74

on

on(listener: Listener<T>): Disposable
Adds a listener function to an event emitter.
Parameters
- listener: Listener<T>
  Function that is called if the event is emitted.
Returns Disposable
Returns a disposable object that should be disposed when not needed anymore.
- Defined in utils/TypedEvent.ts:44

once

once(listener: Listener<T>): void
Adds a listener function to an event emitter that is called only once.
Parameters
- listener: Listener<T>
  Function that is called only once if the event is emitted.
Returns void
- Defined in utils/TypedEvent.ts:59

pipe

pipe(te: TypedEvent<T>): Disposable
Pipes another event emitter to this event emitter.
Parameters
- te: TypedEvent<T>
  Event emitter that is called after this event emitter.
Returns Disposable
Returns a disposable object that should be disposed when not needed anymore.
- Defined in utils/TypedEvent.ts:124

removeAllListeners

removeAllListeners(): void
Removes all listeners from an event emitter.

Returns void
- Defined in utils/TypedEvent.ts:134