@xylabs/events

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/events

Classes

• BaseEmitter
• Events

Interfaces

• BaseEmitterParamsFields
• EventEmitter

Type Aliases

• BaseEmitterParams
• DebugLogger
• EventListenerInfo
• DebugOptions
• MetaEventData
• EventsParams
• EventName
• EventArgs
• EventData
• EventUnsubscribeFunction
• EventAnyListener
• EventListener

classes

BaseEmitter

@xylabs/events

Extends

• Base<TParams>

Type Parameters

TParams

TParams extends BaseParams = BaseParams

TEventData

TEventData extends EventData = EventData

Implements

• EventEmitter<TEventData>

Constructors

Constructor

new BaseEmitter<TParams, TEventData>(params): BaseEmitter<TParams, TEventData>;

Parameters

params

BaseParams<TParams>

Returns

BaseEmitter<TParams, TEventData>

Overrides

Base<TParams>.constructor

Properties

defaultLogger?

static optional defaultLogger: Logger;

Inherited from

Base.defaultLogger

globalInstances

readonly static globalInstances: Record<BaseClassName, WeakRef<Base>[]>;

Inherited from

Base.globalInstances

globalInstancesCountHistory

readonly static globalInstancesCountHistory: Record<BaseClassName, number[]>;

Inherited from

Base.globalInstancesCountHistory

uniqueName

readonly static uniqueName: string;

Inherited from

Base.uniqueName

eventData

eventData: TEventData;

Implementation of

EventEmitter.eventData

Accessors

historyInterval

Get Signature

get static historyInterval(): number;

Returns

number

Set Signature

set static historyInterval(value): void;

Parameters

value

number

Returns

void

Inherited from

Base.historyInterval

historyTime

Get Signature

get static historyTime(): number;

Returns

number

Set Signature

set static historyTime(value): void;

Parameters

value

number

Returns

void

Inherited from

Base.historyTime

maxGcFrequency

Get Signature

get static maxGcFrequency(): number;

Returns

number

Set Signature

set static maxGcFrequency(value): void;

Parameters

value

number

Returns

void

Inherited from

Base.maxGcFrequency

maxHistoryDepth

Get Signature

get static maxHistoryDepth(): number;

Returns

number

Inherited from

Base.maxHistoryDepth

logger

Get Signature

get logger(): undefined | Logger;

Returns

undefined | Logger

Inherited from

Base.logger

meter

Get Signature

get meter(): undefined | Meter;

Returns

undefined | Meter

Inherited from

Base.meter

params

Get Signature

get params(): BaseParams<TParams>;

Returns

BaseParams<TParams>

Inherited from

Base.params

tracer

Get Signature

get tracer(): undefined | Tracer;

Returns

undefined | Tracer

Inherited from

Base.tracer

Methods

gc()

Call Signature

static gc(force?): void;

Parameters

force?

boolean

Returns

void

Inherited from

Base.gc

Call Signature

static gc(className): void;

Parameters

className

string

Returns

void

Inherited from

Base.gc

instanceCount()

static instanceCount(className): number;

Parameters

className

string

Returns

number

Inherited from

Base.instanceCount

instanceCounts()

static instanceCounts(): Record<BaseClassName, number>;

Returns

Record<BaseClassName, number>

Inherited from

Base.instanceCounts

startHistory()

static startHistory(): void;

Returns

void

Inherited from

Base.startHistory

stopHistory()

static stopHistory(): void;

Returns

void

Inherited from

Base.stopHistory

clearListeners()

clearListeners(eventNames): BaseEmitter<TParams, TEventData>;

Parameters

eventNames

keyof TEventData | keyof TEventData[]

Returns

BaseEmitter<TParams, TEventData>

Implementation of

EventEmitter.clearListeners

emit()

emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;

Type Parameters

TEventName

TEventName extends string | number | symbol = keyof TEventData

TEventArgs

TEventArgs extends EventArgs = TEventData[TEventName]

Parameters

eventName

TEventName

eventArgs

TEventArgs

Returns

Promise<void>

Implementation of

EventEmitter.emit

emitSerial()

emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;

Type Parameters

TEventName

TEventName extends string | number | symbol = keyof TEventData

TEventArgs

TEventArgs extends EventArgs = TEventData[TEventName]

Parameters

eventName

TEventName

eventArgs

TEventArgs

Returns

Promise<void>

Implementation of

EventEmitter.emitSerial

listenerCount()

listenerCount(eventNames): number;

Parameters

eventNames

keyof TEventData | keyof TEventData[]

Returns

number

Implementation of

EventEmitter.listenerCount

off()

off<TEventName>(eventNames, listener): void;

Type Parameters

TEventName

TEventName extends string | number | symbol

Parameters

eventNames

TEventName | TEventName[]

listener

EventListener<TEventData[TEventName]>

Returns

void

Implementation of

EventEmitter.off

offAny()

offAny(listener): void;

Parameters

listener

EventAnyListener

Returns

void

Implementation of

EventEmitter.offAny

on()

on<TEventName>(eventNames, listener): (...args) => void;

Type Parameters

TEventName

TEventName extends string | number | symbol

Parameters

eventNames

TEventName | TEventName[]

listener

EventListener<TEventData[TEventName]>

Returns

(...args): void;

Parameters

args

...[]

Returns

void

Implementation of

EventEmitter.on

onAny()

onAny(listener): (...args) => void;

Parameters

listener

EventAnyListener

Returns

(...args): void;

Parameters

args

...[]

Returns

void

Implementation of

EventEmitter.onAny

once()

once<TEventName>(eventName, listener): (...args) => void;

Type Parameters

TEventName

TEventName extends string | number | symbol

Parameters

eventName

TEventName

listener

EventListener<TEventData[TEventName]>

Returns

(...args): void;

Parameters

args

...[]

Returns

void

Implementation of

EventEmitter.once

Events

@xylabs/events

Extends

• Base<EventsParams>

Type Parameters

TEventData

TEventData extends EventData = EventData

Implements

• EventEmitter<TEventData>

Constructors

Constructor

new Events<TEventData>(params): Events<TEventData>;

Parameters

params

EventsParams = {}

Returns

Events<TEventData>

Overrides

Base<EventsParams>.constructor

Properties

defaultLogger?

static optional defaultLogger: Logger;

Inherited from

Base.defaultLogger

globalInstances

readonly static globalInstances: Record<BaseClassName, WeakRef<Base>[]>;

Inherited from

Base.globalInstances

globalInstancesCountHistory

readonly static globalInstancesCountHistory: Record<BaseClassName, number[]>;

Inherited from

Base.globalInstancesCountHistory

uniqueName

readonly static uniqueName: string;

Inherited from

Base.uniqueName

anyMap

protected static anyMap: WeakMap<object, Set<EventAnyListener>>;

eventsMap

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

eventData

eventData: TEventData;

Implementation of

EventEmitter.eventData

Accessors

historyInterval

Get Signature

get static historyInterval(): number;

Returns

number

Set Signature

set static historyInterval(value): void;

Parameters

value

number

Returns

void

Inherited from

Base.historyInterval

historyTime

Get Signature

get static historyTime(): number;

Returns

number

Set Signature

set static historyTime(value): void;

Parameters

value

number

Returns

void

Inherited from

Base.historyTime

maxGcFrequency

Get Signature

get static maxGcFrequency(): number;

Returns

number

Set Signature

set static maxGcFrequency(value): void;

Parameters

value

number

Returns

void

Inherited from

Base.maxGcFrequency

maxHistoryDepth

Get Signature

get static maxHistoryDepth(): number;

Returns

number

Inherited from

Base.maxHistoryDepth

logger

Get Signature

get logger(): undefined | Logger;

Returns

undefined | Logger

Inherited from

Base.logger

meter

Get Signature

get meter(): undefined | Meter;

Returns

undefined | Meter

Inherited from

Base.meter

params

Get Signature

get params(): BaseParams<TParams>;

Returns

BaseParams<TParams>

Inherited from

Base.params

tracer

Get Signature

get tracer(): undefined | Tracer;

Returns

undefined | Tracer

Inherited from

Base.tracer

isDebugEnabled

Get Signature

get static isDebugEnabled(): boolean;

Returns

boolean

Set Signature

set static isDebugEnabled(newValue): void;

Parameters

newValue

boolean

Returns

void

debug

Get Signature

get debug(): undefined | DebugOptions;

Returns

undefined | DebugOptions

Methods

gc()

Call Signature

static gc(force?): void;

Parameters

force?

boolean

Returns

void

Inherited from

Base.gc

Call Signature

static gc(className): void;

Parameters

className

string

Returns

void

Inherited from

Base.gc

instanceCount()

static instanceCount(className): number;

Parameters

className

string

Returns

number

Inherited from

Base.instanceCount

instanceCounts()

static instanceCounts(): Record<BaseClassName, number>;

Returns

Record<BaseClassName, number>

Inherited from

Base.instanceCounts

startHistory()

static startHistory(): void;

Returns

void

Inherited from

Base.startHistory

stopHistory()

static stopHistory(): void;

Returns

void

Inherited from

Base.stopHistory

clearListeners()

clearListeners(eventNames): void;

Parameters

eventNames

keyof TEventData | keyof TEventData[]

Returns

void

Implementation of

EventEmitter.clearListeners

emit()

emit<TEventName>(eventName, eventArgs): Promise<void>;

Type Parameters

TEventName

TEventName extends string | number | symbol

Parameters

eventName

TEventName

eventArgs

TEventData[TEventName]

Returns

Promise<void>

Implementation of

EventEmitter.emit

emitMetaEvent()

emitMetaEvent<TEventName>(eventName, eventArgs): Promise<undefined | boolean>;

Type Parameters

TEventName

TEventName extends keyof MetaEventData<TEventData>

Parameters

eventName

TEventName

eventArgs

MetaEventData<TEventData>[TEventName]

Returns

Promise<undefined | boolean>

emitSerial()

emitSerial<TEventName>(eventName, eventArgs): Promise<void>;

Type Parameters

TEventName

TEventName extends string | number | symbol

Parameters

eventName

TEventName

eventArgs

TEventData[TEventName]

Returns

Promise<void>

Implementation of

EventEmitter.emitSerial

listenerCount()

listenerCount(eventNames?): number;

Parameters

eventNames?

keyof TEventData | keyof TEventData[]

Returns

number

Implementation of

EventEmitter.listenerCount

logIfDebugEnabled()

logIfDebugEnabled<TEventName>(
   type, 
   eventName?, 
   eventArgs?): void;

Type Parameters

TEventName

TEventName extends PropertyKey

Parameters

type

string

eventName?

TEventName

eventArgs?

EventArgs

Returns

void

off()

off<TEventName, TEventListener>(eventNames, listener): void;

Type Parameters

TEventName

TEventName extends string | number | symbol

TEventListener

TEventListener = EventListener<TEventData[TEventName]>

Parameters

eventNames

TEventName | TEventName[]

listener

TEventListener

Returns

void

Implementation of

EventEmitter.off

offAny()

offAny(listener): void;

Parameters

listener

EventAnyListener

Returns

void

Implementation of

EventEmitter.offAny

on()

on<TEventName>(
   eventNames, 
   listener, 
   filter?): (...args) => void;

Type Parameters

TEventName

TEventName extends string | number | symbol = keyof TEventData

Parameters

eventNames

TEventName | TEventName[]

listener

EventListener<TEventData[TEventName]>

filter?

TEventData[TEventName]

Returns

(...args): void;

Parameters

args

...[]

Returns

void

Implementation of

EventEmitter.on

onAny()

onAny(listener): (...args) => void;

Parameters

listener

EventAnyListener

Returns

(...args): void;

Parameters

args

...[]

Returns

void

Implementation of

EventEmitter.onAny

once()

once<TEventName>(eventName, listener): (...args) => void;

Type Parameters

TEventName

TEventName extends string | number | symbol

Parameters

eventName

TEventName

listener

EventListener<TEventData[TEventName]>

Returns

(...args): void;

Parameters

args

...[]

Returns

void

Implementation of

EventEmitter.once

interfaces

BaseEmitterParamsFields

@xylabs/events

EventEmitter

@xylabs/events

Type Parameters

T

T extends EventData

Properties

eventData

eventData: T;

Methods

clearListeners()

clearListeners(eventNames): void;

Parameters

eventNames

keyof T | keyof T[]

Returns

void

emit()

emit<TEventName>(eventName, eventArgs): Promise<void>;

Type Parameters

TEventName

TEventName extends string | number | symbol

Parameters

eventName

TEventName

eventArgs

T[TEventName]

Returns

Promise<void>

emitSerial()

emitSerial<TEventName>(eventName, eventArgs): Promise<void>;

Type Parameters

TEventName

TEventName extends string | number | symbol

Parameters

eventName

TEventName

eventArgs

T[TEventName]

Returns

Promise<void>

listenerCount()

listenerCount(eventNames): number;

Parameters

eventNames

keyof T | keyof T[]

Returns

number

off()

off<TEventName>(eventNames, listener): void;

Type Parameters

TEventName

TEventName extends string | number | symbol

Parameters

eventNames

TEventName | TEventName[]

listener

EventListener<T[TEventName]>

Returns

void

offAny()

offAny(listener): void;

Parameters

listener

Promise<void> | EventAnyListener

Returns

void

on()

on<TEventName>(eventNames, listener): EventUnsubscribeFunction;

Type Parameters

TEventName

TEventName extends string | number | symbol

Parameters

eventNames

TEventName | TEventName[]

listener

EventListener<T[TEventName]>

Returns

EventUnsubscribeFunction

onAny()

onAny(listener): EventUnsubscribeFunction;

Parameters

listener

EventAnyListener

Returns

EventUnsubscribeFunction

once()

once<TEventName>(eventName, listener): EventUnsubscribeFunction;

Type Parameters

TEventName

TEventName extends string | number | symbol

Parameters

eventName

TEventName

listener

EventListener<T[TEventName]>

Returns

EventUnsubscribeFunction

type-aliases

BaseEmitterParams

@xylabs/events

type BaseEmitterParams<T> = BaseParams<T & BaseEmitterParamsFields & T>;

Type Parameters

T

T extends EmptyObject = EmptyObject

DebugLogger

@xylabs/events

type DebugLogger = (type, debugName, eventName?, eventData?) => void;

Emittery can collect and log debug information.

To enable this feature set the DEBUG environment variable to emittery or *. Additionally, you can set the static isDebugEnabled variable to true on the Emittery class, or myEmitter.debug.enabled on an instance of it for debugging a single instance.

See API for more information on how debugging works.

Parameters

type

string

debugName

string

eventName?

EventName

eventData?

EventArgs

Returns

void

DebugOptions

@xylabs/events

type DebugOptions = object;

Configure debug options of an instance.

Properties

enabled?

optional enabled: boolean;

logger?

optional logger: DebugLogger;

name

readonly name: string;

EventAnyListener

@xylabs/events

type EventAnyListener<TEventArgs> = (eventName, eventData) => Promisable<void>;

Type Parameters

TEventArgs

TEventArgs extends EventArgs = EventArgs

Parameters

eventName

EventName

eventData

TEventArgs

Returns

Promisable<void>

EventArgs

@xylabs/events

type EventArgs = string | number | object;

EventData

@xylabs/events

type EventData = object;

Index Signature

[key: string | number | symbol]: EventArgs

EventListener

@xylabs/events

type EventListener<TEventArgs> = (eventData) => Promisable<void>;

Type Parameters

TEventArgs

TEventArgs extends EventArgs = EventArgs

Parameters

eventData

TEventArgs

Returns

Promisable<void>

EventListenerInfo

@xylabs/events

type EventListenerInfo<TEventArgs> = object;

Type Parameters

TEventArgs

TEventArgs extends EventArgs = EventArgs

Properties

filter?

optional filter: TEventArgs;

listener

listener: EventListener<TEventArgs>;

EventName

@xylabs/events

type EventName = PropertyKey;

EventUnsubscribeFunction

@xylabs/events

type EventUnsubscribeFunction = () => void;

Returns

void

EventsParams

@xylabs/events

type EventsParams = BaseParams<{
  debug?: DebugOptions;
}>;

MetaEventData

@xylabs/events

type MetaEventData<TEventData> = object;

Type Parameters

TEventData

TEventData extends EventData

Properties

listenerAdded

listenerAdded: object;

eventName?

optional eventName: keyof TEventData;

listener

listener: 
  | EventListener<TEventData[keyof TEventData]>
| EventAnyListener<TEventData[keyof TEventData]>;

listenerRemoved

listenerRemoved: object;

eventName?

optional eventName: keyof TEventData;

listener

listener: 
  | EventListener<TEventData[keyof TEventData]>
| EventAnyListener<TEventData[keyof TEventData]>;

Part of sdk-js

Maintainers

• Arie Trouw (arietrouw.com)
• Matt Jones
• Joel Carter
• Jordan Trouw

License

See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs