Class Events<TEventData>

Type Parameters

TEventData extends EventData = EventData

Hierarchy (View Summary)

Base<EventsParams>
- Events

Implements

EventFunctions<TEventData>

Constructors

constructor

new Events<TEventData extends EventData = EventData>(
params?: BaseParamsFields & { debug?: DebugOptions },
): Events<TEventData>
Type Parameters
- TEventData extends EventData = EventData
Parameters
- Optionalparams: BaseParamsFields & { debug?: DebugOptions }
Returns Events<TEventData>
Overrides Base.constructor
- Defined in packages/modules/packages/module/packages/events/dist/neutral/index.d.ts:54

Properties

eventData

eventData: TEventData

`Protected` `Static`anyMap

anyMap: WeakMap<object, Set<EventAnyListener<EventArgs>>>

`Static` `Optional`defaultLogger

defaultLogger?: Logger

`Protected` `Static`eventsMap

eventsMap: WeakMap<object, Map<PropertyKey, Set<EventListenerInfo<EventArgs>>>>

`Static` `Readonly`globalInstances

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

`Static` `Readonly`globalInstancesCountHistory

globalInstancesCountHistory: Record<string, number[]>

`Static` `Readonly`uniqueName

uniqueName: string

Accessors

debug

get debug(): undefined | DebugOptions
Returns undefined | DebugOptions
- Defined in packages/modules/packages/module/packages/events/dist/neutral/index.d.ts:57

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`isDebugEnabled

get isDebugEnabled(): boolean
Returns boolean
- Defined in packages/modules/packages/module/packages/events/dist/neutral/index.d.ts:55
set isDebugEnabled(newValue: boolean): void
Parameters
- newValue: boolean
Returns void
- Defined in packages/modules/packages/module/packages/events/dist/neutral/index.d.ts:56

`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/events/dist/neutral/index.d.ts:58

emit

emit<TEventName extends string | number | symbol>(
eventName: TEventName,
eventArgs: TEventData[TEventName],
): Promise<void>
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- eventArgs: TEventData[TEventName]
Returns Promise<void>
Implementation of EventFunctions.emit
- Defined in packages/modules/packages/module/packages/events/dist/neutral/index.d.ts:59

emitMetaEvent

emitMetaEvent<TEventName extends keyof MetaEventData<TEventData>>(
eventName: TEventName,
eventArgs: MetaEventData<TEventData>[TEventName],
): Promise<void>
Type Parameters
- TEventName extends keyof MetaEventData<TEventData>
Parameters
- eventName: TEventName
- eventArgs: MetaEventData<TEventData>[TEventName]
Returns Promise<void>
- Defined in packages/modules/packages/module/packages/events/dist/neutral/index.d.ts:60

emitSerial

emitSerial<TEventName extends string | number | symbol>(
eventName: TEventName,
eventArgs: TEventData[TEventName],
): Promise<void>
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- eventArgs: TEventData[TEventName]
Returns Promise<void>
Implementation of EventFunctions.emitSerial
- Defined in packages/modules/packages/module/packages/events/dist/neutral/index.d.ts:61

listenerCount

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

logIfDebugEnabled

logIfDebugEnabled<TEventName extends PropertyKey>(
    type: string,
    eventName?: TEventName,
    eventArgs?: EventArgs,
): void
Type Parameters
- TEventName extends PropertyKey
Parameters
- type: string
- OptionaleventName: TEventName
- OptionaleventArgs: EventArgs
Returns void
- Defined in packages/modules/packages/module/packages/events/dist/neutral/index.d.ts:63

off

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

offAny

offAny(listener: EventAnyListener<EventArgs>): void
Parameters
- listener: EventAnyListener<EventArgs>
Returns void
Implementation of EventFunctions.offAny
- Defined in packages/modules/packages/module/packages/events/dist/neutral/index.d.ts:65

on

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

onAny

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

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/events/dist/neutral/index.d.ts:68

`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 Events<TEventData>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Events<TEventData>

Properties

eventData

Protected StaticanyMap

Static OptionaldefaultLogger

Protected StaticeventsMap

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

Static ReadonlyuniqueName

Accessors

debug

Returns undefined | DebugOptions

logger

Returns undefined | Logger

params

Returns TParams

StatichistoryInterval

Returns number

Parameters

Returns void

StatichistoryTime

Returns number

Parameters

Returns void

StaticisDebugEnabled

Returns boolean

Parameters

Returns void

StaticmaxGcFrequency

Returns number

Parameters

Returns void

StaticmaxHistoryDepth

Returns number

Methods

clearListeners

Parameters

Returns void

emit

Type Parameters

Parameters

Returns Promise<void>

emitMetaEvent

Type Parameters

Parameters

Returns Promise<void>

emitSerial

Type Parameters

Parameters

Returns Promise<void>

listenerCount

Parameters

Returns number

logIfDebugEnabled

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

offAny

Parameters

Returns void

on

Type Parameters

Parameters

`Protected` `Static`anyMap

`Static` `Optional`defaultLogger

`Protected` `Static`eventsMap

`Static` `Readonly`globalInstances

`Static` `Readonly`globalInstancesCountHistory

`Static` `Readonly`uniqueName

`Static`historyInterval

`Static`historyTime

`Static`isDebugEnabled

`Static`maxGcFrequency

`Static`maxHistoryDepth

`Static`gc

`Static`instanceCount

`Static`instanceCounts

`Static`startHistory

`Static`stopHistory