Class ShogunEventEmitter

Extended EventEmitter class with typed events for Shogun ShogunEventEmitter

Hierarchy

EventEmitter<ShogunEventMap>
- ShogunEventEmitter

Index

Constructors

Methods

emit off on once removeAllListeners

Constructors

constructor

new ShogunEventEmitter(): ShogunEventEmitter
Returns ShogunEventEmitter
Inherited from EventEmitter<ShogunEventMap>.constructor

Methods

emit

emit<K extends keyof ShogunEventMap>(
event: K,
data?: ShogunEventMap[K],
): boolean
Emit a typed Shogun event
Type Parameters
- K extends keyof ShogunEventMap
  Event key type
Parameters
- event: K
  Event name
- Optionaldata: ShogunEventMap[K]
  Event data
Returns boolean
- Returns true if the event had listeners, false otherwise
Overrides EventEmitter.emit

off

off<K extends keyof ShogunEventMap>(
event: K,
listener: (data: ShogunEventMap[K]) => void,
): void
Remove a listener for a typed Shogun event
Type Parameters
- K extends keyof ShogunEventMap
  Event key type
Parameters
- event: K
  Event name
- listener: (data: ShogunEventMap[K]) => void
  Event listener function to remove
Returns void
Overrides EventEmitter.off

on

on<K extends keyof ShogunEventMap>(
event: K,
listener: (data: ShogunEventMap[K]) => void,
): void
Register a listener for a typed Shogun event
Type Parameters
- K extends keyof ShogunEventMap
  Event key type
Parameters
- event: K
  Event name
- listener: (data: ShogunEventMap[K]) => void
  Event listener function
Returns void
Overrides EventEmitter.on

once

once(event: EventType, listener: (data: unknown) => void): void
Registers a one-time event listener
Parameters
- event: EventType
- listener: (data: unknown) => void
Returns void
Inherited from EventEmitter.once

removeAllListeners

removeAllListeners(event?: EventType): void
Removes all listeners for an event or all events
Parameters
- Optionalevent: EventType
Returns void
Inherited from EventEmitter.removeAllListeners