Class TypedEventEmitter<Events, Arguments, SuperclassArguments>

Typed Event Emitter class which can act as a Base Model for all our model and communication events. This makes it much easier for us to distinguish between events, as we now need to properly type this, so that our events are not stringly-based and prone to silly typos.

Type Parameters

Events extends string
Arguments extends ListenerMap<Events>
SuperclassArguments extends ListenerMap<any> = Arguments

Hierarchy

EventEmitter
- TypedEventEmitter

Index

Constructors

constructor

Methods

addListener emit eventNames listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener

Constructors

constructor

new TypedEventEmitter<Events, Arguments, SuperclassArguments>(options?: EventEmitterOptions): TypedEventEmitter<Events, Arguments, SuperclassArguments>
Type Parameters
- Events extends string
- Arguments extends ListenerMap<Events>
- SuperclassArguments extends ListenerMap<any> = Arguments
Parameters
- Optional options: EventEmitterOptions
Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>
Inherited from EventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:111

Methods

addListener

addListener<T>(event: T, listener: Listener<Events, Arguments, T>): TypedEventEmitter<Events, Arguments, SuperclassArguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Events, Arguments, T>
Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>
Overrides EventEmitter.addListener
- Defined in src/models/typed-event-emitter.ts:49

emit

emit<T>(event: T, ...args: Parameters<SuperclassArguments[T]>): boolean
Type Parameters
- T extends string
Parameters
- event: T
- Rest ...args: Parameters<SuperclassArguments[T]>
Returns boolean
Overrides EventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:56
emit<T>(event: T, ...args: Parameters<Arguments[T]>): boolean
Type Parameters
- T extends string
Parameters
- event: T
- Rest ...args: Parameters<Arguments[T]>
Returns boolean
Overrides EventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:57

eventNames

eventNames(): (EventEmitterEvents | Events)[]
Returns (EventEmitterEvents | Events)[]
Overrides EventEmitter.eventNames
- Defined in src/models/typed-event-emitter.ts:62

listenerCount

listenerCount(event: EventEmitterEvents | Events): number
Parameters
- event: EventEmitterEvents | Events
Returns number
Overrides EventEmitter.listenerCount
- Defined in src/models/typed-event-emitter.ts:66

listeners

listeners(event: EventEmitterEvents | Events): Function[]
Parameters
- event: EventEmitterEvents | Events
Returns Function[]
Overrides EventEmitter.listeners
- Defined in src/models/typed-event-emitter.ts:70

off

off<T>(event: T, listener: Listener<Events, Arguments, T>): TypedEventEmitter<Events, Arguments, SuperclassArguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Events, Arguments, T>
Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>
Overrides EventEmitter.off
- Defined in src/models/typed-event-emitter.ts:74

on

on<T>(event: T, listener: Listener<Events, Arguments, T>): TypedEventEmitter<Events, Arguments, SuperclassArguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Events, Arguments, T>
Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>
Overrides EventEmitter.on
- Defined in src/models/typed-event-emitter.ts:78

once

once<T>(event: T, listener: Listener<Events, Arguments, T>): TypedEventEmitter<Events, Arguments, SuperclassArguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Events, Arguments, T>
Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>
Overrides EventEmitter.once
- Defined in src/models/typed-event-emitter.ts:82

prependListener

prependListener<T>(event: T, listener: Listener<Events, Arguments, T>): TypedEventEmitter<Events, Arguments, SuperclassArguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Events, Arguments, T>
Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>
Overrides EventEmitter.prependListener
- Defined in src/models/typed-event-emitter.ts:86

prependOnceListener

prependOnceListener<T>(event: T, listener: Listener<Events, Arguments, T>): TypedEventEmitter<Events, Arguments, SuperclassArguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Events, Arguments, T>
Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>
Overrides EventEmitter.prependOnceListener
- Defined in src/models/typed-event-emitter.ts:93

rawListeners

rawListeners(event: EventEmitterEvents | Events): Function[]
Parameters
- event: EventEmitterEvents | Events
Returns Function[]
Overrides EventEmitter.rawListeners
- Defined in src/models/typed-event-emitter.ts:111

removeAllListeners

removeAllListeners(event?: EventEmitterEvents | Events): TypedEventEmitter<Events, Arguments, SuperclassArguments>
Parameters
- Optional event: EventEmitterEvents | Events
Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>
Overrides EventEmitter.removeAllListeners
- Defined in src/models/typed-event-emitter.ts:100

removeListener

removeListener<T>(event: T, listener: Listener<Events, Arguments, T>): TypedEventEmitter<Events, Arguments, SuperclassArguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Events, Arguments, T>
Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>
Overrides EventEmitter.removeListener
- Defined in src/models/typed-event-emitter.ts:104

Class TypedEventEmitter<Events, Arguments, SuperclassArguments>

Type Parameters

Events extends string

Arguments extends ListenerMap<Events>

SuperclassArguments extends ListenerMap<any> = Arguments

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Events extends string

Arguments extends ListenerMap<Events>

SuperclassArguments extends ListenerMap<any> = Arguments

Parameters

Optional options: EventEmitterOptions

Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>

Methods

addListener

Type Parameters

T extends string

Parameters

event: T

listener: Listener<Events, Arguments, T>

Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>

emit

Type Parameters

T extends string

Parameters

event: T

Rest ...args: Parameters<SuperclassArguments[T]>

Returns boolean

Type Parameters

T extends string

Parameters

event: T

Rest ...args: Parameters<Arguments[T]>

Returns boolean

eventNames

Returns (EventEmitterEvents | Events)[]

listenerCount

Parameters

event: EventEmitterEvents | Events

Returns number

listeners

Parameters

event: EventEmitterEvents | Events

Returns Function[]

off

Type Parameters

T extends string

Parameters

event: T

listener: Listener<Events, Arguments, T>

Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>

on

Type Parameters

T extends string

Parameters

event: T

listener: Listener<Events, Arguments, T>

Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>

once

Type Parameters

T extends string

Parameters

event: T

listener: Listener<Events, Arguments, T>

Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>

prependListener

Type Parameters

T extends string

Parameters

event: T

listener: Listener<Events, Arguments, T>

Returns TypedEventEmitter<Events, Arguments, SuperclassArguments>

prependOnceListener

Type Parameters

T extends string

`Optional` options: EventEmitterOptions

`Rest` ...args: Parameters<SuperclassArguments[T]>

`Rest` ...args: Parameters<Arguments[T]>

`Optional` event: EventEmitterEvents | Events