Class BaseEmitter<TParams, TEventData>

Type Parameters

TParams extends BaseParams = BaseParams
TEventData extends EventData = EventData

Hierarchy (View Summary)

Base<TParams>
- BaseEmitter
  - AbstractModule

Implements

EventFunctions<TEventData>

Index

Constructors

constructor

new BaseEmitter<
    TParams extends BaseParamsFields = BaseParamsFields,
    TEventData extends EventData = EventData,
>(
    params: TParams,
): BaseEmitter<TParams, TEventData>
Type Parameters
- TParams extends BaseParamsFields = BaseParamsFields
- TEventData extends EventData = EventData
Parameters
- params: TParams
Returns BaseEmitter<TParams, TEventData>
Overrides Base.constructor
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:7

Properties

eventData

eventData: TEventData

`Static` `Optional`defaultLogger

defaultLogger?: Logger

`Static` `Readonly`globalInstances

globalInstances: Record<string, WeakRef<Base<undefined | BaseParamsFields>>[]>

`Static` `Readonly`globalInstancesCountHistory

globalInstancesCountHistory: Record<string, number[]>

`Static` `Readonly`uniqueName

uniqueName: string

Accessors

logger

get logger(): undefined | Logger
Returns undefined | Logger
Inherited from Base.logger
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:27

params

get params(): TParams
Returns TParams
Inherited from Base.params
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:28

`Static`historyInterval

get historyInterval(): number
Returns number
Inherited from Base.historyInterval
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:20
set historyInterval(value: number): void
Parameters
- value: number
Returns void
Inherited from Base.historyInterval
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:21

`Static`historyTime

get historyTime(): number
Returns number
Inherited from Base.historyTime
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:22
set historyTime(value: number): void
Parameters
- value: number
Returns void
Inherited from Base.historyTime
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:23

`Static`maxGcFrequency

get maxGcFrequency(): number
Returns number
Inherited from Base.maxGcFrequency
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:24
set maxGcFrequency(value: number): void
Parameters
- value: number
Returns void
Inherited from Base.maxGcFrequency
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:25

`Static`maxHistoryDepth

get maxHistoryDepth(): number
Returns number
Inherited from Base.maxHistoryDepth
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:26

Methods

clearListeners

clearListeners(eventNames: keyof TEventData | (keyof TEventData)[]): void
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns void
Implementation of EventFunctions.clearListeners
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:8

emit

emit<
    TEventName extends string
    | number
    | symbol = keyof TEventData,
    TEventArgs extends EventArgs = TEventData[TEventName],
>(
    eventName: TEventName,
    eventArgs: TEventArgs,
): 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 packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:9

emitSerial

emitSerial<
    TEventName extends string
    | number
    | symbol = keyof TEventData,
    TEventArgs extends EventArgs = TEventData[TEventName],
>(
    eventName: TEventName,
    eventArgs: TEventArgs,
): 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 packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:10

listenerCount

listenerCount(eventNames: keyof TEventData | (keyof TEventData)[]): number
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns number
Implementation of EventFunctions.listenerCount
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:11

off

off<TEventName extends string | number | symbol>(
eventNames: TEventName | TEventName[],
listener: EventListener<TEventData[TEventName]>,
): void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns void
Implementation of EventFunctions.off
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:12

offAny

offAny(listener: EventAnyListener): void
Parameters
- listener: EventAnyListener
Returns void
Implementation of EventFunctions.offAny
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:13

on

on<TEventName extends string | number | symbol>(
eventNames: TEventName | TEventName[],
listener: EventListener<TEventData[TEventName]>,
): () => void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns () => void
Implementation of EventFunctions.on
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:14

onAny

onAny(listener: EventAnyListener): () => void
Parameters
- listener: EventAnyListener
Returns () => void
Implementation of EventFunctions.onAny
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:15

once

once<TEventName extends string | number | symbol>(
eventName: TEventName,
listener: EventListener<TEventData[TEventName]>,
): () => void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- listener: EventListener<TEventData[TEventName]>
Returns () => void
Implementation of EventFunctions.once
- Defined in packages/modules/packages/module/packages/emitter/dist/neutral/index.d.ts:16

`Static`gc

gc(force?: boolean): void
Parameters
- Optionalforce: boolean
Returns void
Inherited from Base.gc
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:29
gc(className: string): void
Parameters
- className: string
Returns void
Inherited from Base.gc
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:30

`Static`instanceCount

instanceCount(className: string): number
Parameters
- className: string
Returns number
Inherited from Base.instanceCount
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:31

`Static`instanceCounts

instanceCounts(): Record<string, number>
Returns Record<string, number>
Inherited from Base.instanceCounts
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:32

`Static`startHistory

startHistory(): void
Returns void
Inherited from Base.startHistory
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:33

`Static`stopHistory

stopHistory(): void
Returns void
Inherited from Base.stopHistory
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:34

Class BaseEmitter<TParams, TEventData>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseEmitter<TParams, TEventData>

Properties

eventData

Static OptionaldefaultLogger

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

Static ReadonlyuniqueName

Accessors

logger

Returns undefined | Logger

params

Returns TParams

StatichistoryInterval

Returns number

Parameters

Returns void

StatichistoryTime

Returns number

Parameters

Returns void

StaticmaxGcFrequency

Returns number

Parameters

Returns void

StaticmaxHistoryDepth

Returns number

Methods

clearListeners

Parameters

Returns void

emit

Type Parameters

Parameters

Returns Promise<void>

emitSerial

Type Parameters

Parameters

Returns Promise<void>

listenerCount

Parameters

Returns number

off

Type Parameters

Parameters

Returns void

offAny

Parameters

Returns void

on

Type Parameters

Parameters

Returns () => void

onAny

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns () => void

Staticgc

Parameters

Returns void

Parameters

Returns void

StaticinstanceCount

Parameters

Returns number

`Static` `Optional`defaultLogger

`Static` `Readonly`globalInstances

`Static` `Readonly`globalInstancesCountHistory

`Static` `Readonly`uniqueName

`Static`historyInterval

`Static`historyTime

`Static`maxGcFrequency

`Static`maxHistoryDepth

`Static`gc

`Static`instanceCount

`Static`instanceCounts

`Static`startHistory

`Static`stopHistory