Class BaseEmitter<TParams, TEventData>

Type Parameters

TParams extends BaseParams = BaseParams
TEventData extends EventData = EventData

Hierarchy

Base<TParams>
- BaseEmitter
  - AbstractModule

Implements

EventFunctions<TEventData>

Index

Constructors

Properties

eventData events params defaultLogger?

Accessors

Methods

clearListeners emit emitSerial listenerCount off offAny on onAny once

Constructors

constructor

new BaseEmitter<TParams, TEventData>(params): BaseEmitter<TParams, TEventData>
Type Parameters
- TParams extends BaseParamsFields = BaseParamsFields
- TEventData extends EventData = EventData
Parameters
- params: TParams
Returns BaseEmitter<TParams, TEventData>
Overrides Base<TParams>.constructor
- Defined in modules/packages/module/packages/abstract/src/BaseEmitter.ts:13

Properties

eventData

eventData: TEventData = ...

`Private` events

events: Events<TEventData>

`Readonly` params

params: TParams

`Static` `Optional` defaultLogger

defaultLogger?: Logger

Accessors

`Protected` logger

get logger(): Logger | Console
Returns Logger | Console
Inherited from Base.logger
- Defined in protocol/packages/core/dist/types/lib/Base.d.ts:23

Methods

clearListeners

clearListeners(eventNames): void
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns void
Implementation of EventFunctions.clearListeners
- Defined in modules/packages/module/packages/abstract/src/BaseEmitter.ts:18

emit

emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends string | number | symbol = keyof TEventData
- TEventArgs extends EventArgs = TEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Implementation of EventFunctions.emit
- Defined in modules/packages/module/packages/abstract/src/BaseEmitter.ts:22

emitSerial

emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends string | number | symbol = keyof TEventData
- TEventArgs extends EventArgs = TEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Implementation of EventFunctions.emitSerial
- Defined in modules/packages/module/packages/abstract/src/BaseEmitter.ts:29

listenerCount

listenerCount(eventNames): number
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns number
Implementation of EventFunctions.listenerCount
- Defined in modules/packages/module/packages/abstract/src/BaseEmitter.ts:36

off

off<TEventName>(eventNames, listener): void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns void
Implementation of EventFunctions.off
- Defined in modules/packages/module/packages/abstract/src/BaseEmitter.ts:40

offAny

offAny(listener): void
Parameters
- listener: EventAnyListener<EventArgs>
Returns void
Implementation of EventFunctions.offAny
- Defined in modules/packages/module/packages/abstract/src/BaseEmitter.ts:44

on

on<TEventName>(eventNames, listener): (() => void)
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Implementation of EventFunctions.on
- Defined in modules/packages/module/packages/abstract/src/BaseEmitter.ts:48

onAny

onAny(listener): (() => void)
Parameters
- listener: EventAnyListener<EventArgs>
Returns (() => void)
- - (): void
  - Returns void
Implementation of EventFunctions.onAny
- Defined in modules/packages/module/packages/abstract/src/BaseEmitter.ts:52

once

once<TEventName>(eventName, listener): (() => void)
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- listener: EventListener<TEventData[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Implementation of EventFunctions.once
- Defined in modules/packages/module/packages/abstract/src/BaseEmitter.ts:56

Generated using TypeDoc