@xylabs/events

[![logo][]](https://xylabs.com)

[![main-build][]][main-build-link]
[![npm-badge][]][npm-link]
[![npm-downloads-badge][]][npm-link]
[![jsdelivr-badge][]][jsdelivr-link]
[![npm-license-badge][]](LICENSE)
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]
[![snyk-badge][]][snyk-link]
[![socket-badge][]][socket-link]

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

$3

### BaseEmitter

@xylabs/events

*

Extends

- Base\<TParams\>

Type Parameters

$3

TParams extends BaseParams = BaseParams

$3

TEventData extends EventData = EventData

Implements

- EventEmitter\<TEventData\>

Constructors

$3

``ts
new BaseEmitter(params): BaseEmitter;
`

$3

#### params

BaseParams\<TParams\>

$3

BaseEmitter\<TParams, TEventData\>

$3

`ts
Base.constructor
`

Properties

$3

`ts
static optional defaultLogger: Logger;
`

$3

`ts
Base.defaultLogger
`

*

$3

`ts
readonly static globalInstances: Record[]>;
`

$3

`ts
Base.globalInstances
`

*

$3

`ts
readonly static globalInstancesCountHistory: Record;
`

$3

`ts
Base.globalInstancesCountHistory
`

*

$3

`ts
readonly static uniqueName: string;
`

$3

`ts
Base.uniqueName
`

*

$3

`ts
eventData: TEventData;
`

$3

EventEmitter.eventData

Accessors

$3

$3

`ts
get static historyInterval(): number;
`

#### Returns

number

$3

`ts
set static historyInterval(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

`ts
Base.historyInterval
`

*

$3

$3

`ts
get static historyTime(): number;
`

#### Returns

number

$3

`ts
set static historyTime(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

`ts
Base.historyTime
`

*

$3

$3

`ts
get static maxGcFrequency(): number;
`

#### Returns

number

$3

`ts
set static maxGcFrequency(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

`ts
Base.maxGcFrequency
`

*

$3

$3

`ts
get static maxHistoryDepth(): number;
`

#### Returns

number

$3

`ts
Base.maxHistoryDepth
`

*

$3

$3

`ts
get logger(): undefined | Logger;
`

#### Returns

undefined \| Logger

$3

`ts
Base.logger
`

*

$3

$3

`ts
get meter(): undefined | Meter;
`

#### Returns

undefined \| Meter

$3

`ts
Base.meter
`

*

$3

$3

`ts
get params(): BaseParams;
`

#### Returns

BaseParams\<TParams\>

$3

`ts
Base.params
`

*

$3

$3

`ts
get tracer(): undefined | Tracer;
`

#### Returns

undefined \| Tracer

$3

`ts
Base.tracer
`

Methods

$3

$3

`ts
static gc(force?): void;
`

#### Parameters

##### force?

boolean

#### Returns

void

#### Inherited from

`ts
Base.gc
`

$3

`ts
static gc(className): void;
`

#### Parameters

##### className

string

#### Returns

void

#### Inherited from

`ts
Base.gc
`

*

$3

`ts
static instanceCount(className): number;
`

$3

#### className

string

$3

number

$3

`ts
Base.instanceCount
`

*

$3

`ts
static instanceCounts(): Record;
`

$3

Record\<BaseClassName, number\>

$3

`ts
Base.instanceCounts
`

*

$3

`ts
static startHistory(): void;
`

$3

void

$3

`ts
Base.startHistory
`

*

$3

`ts
static stopHistory(): void;
`

$3

void

$3

`ts
Base.stopHistory
`

*

$3

`ts
clearListeners(eventNames): BaseEmitter;
`

$3

#### eventNames

keyof TEventData | keyof TEventData[]

$3

BaseEmitter\<TParams, TEventData\>

$3

EventEmitter.clearListeners

*

$3

`ts
emit(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol = keyof TEventData

#### TEventArgs

TEventArgs extends EventArgs = TEventData\[TEventName\]

$3

#### eventName

TEventName

#### eventArgs

TEventArgs

$3

Promise\<void\>

$3

EventEmitter.emit

*

$3

`ts
emitSerial(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol = keyof TEventData

#### TEventArgs

TEventArgs extends EventArgs = TEventData\[TEventName\]

$3

#### eventName

TEventName

#### eventArgs

TEventArgs

$3

Promise\<void\>

$3

EventEmitter.emitSerial

*

$3

`ts
listenerCount(eventNames): number;
`

$3

#### eventNames

keyof TEventData | keyof TEventData[]

$3

number

$3

EventEmitter.listenerCount

*

$3

`ts
off(eventNames, listener): void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventNames

TEventName | TEventName[]

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

void

$3

EventEmitter.off

*

$3

`ts
offAny(listener): void;
`

$3

#### listener

EventAnyListener

$3

void

$3

EventEmitter.offAny

*

$3

`ts
on(eventNames, listener): (...args) => void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventNames

TEventName | TEventName[]

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

`ts
(...args): void;
`

#### Parameters

##### args

...\[\]

#### Returns

void

$3

EventEmitter.on

*

$3

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

$3

#### listener

EventAnyListener

$3

`ts
(...args): void;
`

#### Parameters

##### args

...\[\]

#### Returns

void

$3

EventEmitter.onAny

*

$3

`ts
once(eventName, listener): (...args) => void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

`ts
(...args): void;
`

#### Parameters

##### args

...\[\]

#### Returns

void

$3

EventEmitter.once

### Events

@xylabs/events

*

Extends

- Base\<EventsParams\>

Type Parameters

$3

TEventData extends EventData = EventData

Implements

- EventEmitter\<TEventData\>

Constructors

$3

`ts
new Events(params): Events;
`

$3

#### params

EventsParams = {}

$3

Events\<TEventData\>

$3

`ts
Base.constructor
`

Properties

$3

`ts
static optional defaultLogger: Logger;
`

$3

`ts
Base.defaultLogger
`

*

$3

`ts
readonly static globalInstances: Record[]>;
`

$3

`ts
Base.globalInstances
`

*

$3

`ts
readonly static globalInstancesCountHistory: Record;
`

$3

`ts
Base.globalInstancesCountHistory
`

*

$3

`ts
readonly static uniqueName: string;
`

$3

`ts
Base.uniqueName
`

*

$3

`ts
protected static anyMap: WeakMap>;
`

*

$3

`ts
protected static eventsMap: WeakMap>>>;
`

*

$3

`ts
eventData: TEventData;
`

$3

EventEmitter.eventData

Accessors

$3

$3

`ts
get static historyInterval(): number;
`

#### Returns

number

$3

`ts
set static historyInterval(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

`ts
Base.historyInterval
`

*

$3

$3

`ts
get static historyTime(): number;
`

#### Returns

number

$3

`ts
set static historyTime(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

`ts
Base.historyTime
`

*

$3

$3

`ts
get static maxGcFrequency(): number;
`

#### Returns

number

$3

`ts
set static maxGcFrequency(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

`ts
Base.maxGcFrequency
`

*

$3

$3

`ts
get static maxHistoryDepth(): number;
`

#### Returns

number

$3

`ts
Base.maxHistoryDepth
`

*

$3

$3

`ts
get logger(): undefined | Logger;
`

#### Returns

undefined \| Logger

$3

`ts
Base.logger
`

*

$3

$3

`ts
get meter(): undefined | Meter;
`

#### Returns

undefined \| Meter

$3

`ts
Base.meter
`

*

$3

$3

`ts
get params(): BaseParams;
`

#### Returns

BaseParams\<TParams\>

$3

`ts
Base.params
`

*

$3

$3

`ts
get tracer(): undefined | Tracer;
`

#### Returns

undefined \| Tracer

$3

`ts
Base.tracer
`

*

$3

$3

`ts
get static isDebugEnabled(): boolean;
`

#### Returns

boolean

$3

`ts
set static isDebugEnabled(newValue): void;
`

#### Parameters

##### newValue

boolean

#### Returns

void

*

$3

$3

`ts
get debug(): undefined | DebugOptions;
`

#### Returns

undefined \| DebugOptions

Methods

$3

$3

`ts
static gc(force?): void;
`

#### Parameters

##### force?

boolean

#### Returns

void

#### Inherited from

`ts
Base.gc
`

$3

`ts
static gc(className): void;
`

#### Parameters

##### className

string

#### Returns

void

#### Inherited from

`ts
Base.gc
`

*

$3

`ts
static instanceCount(className): number;
`

$3

#### className

string

$3

number

$3

`ts
Base.instanceCount
`

*

$3

`ts
static instanceCounts(): Record;
`

$3

Record\<BaseClassName, number\>

$3

`ts
Base.instanceCounts
`

*

$3

`ts
static startHistory(): void;
`

$3

void

$3

`ts
Base.startHistory
`

*

$3

`ts
static stopHistory(): void;
`

$3

void

$3

`ts
Base.stopHistory
`

*

$3

`ts
clearListeners(eventNames): void;
`

$3

#### eventNames

keyof TEventData | keyof TEventData[]

$3

void

$3

EventEmitter.clearListeners

*

$3

`ts
emit(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### eventArgs

TEventData\[TEventName\]

$3

Promise\<void\>

$3

EventEmitter.emit

*

$3

`ts
emitMetaEvent(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends keyof MetaEventData\<TEventData\>

$3

#### eventName

TEventName

#### eventArgs

MetaEventData\<TEventData\>\[TEventName\]

$3

Promise\<undefined \| boolean\>

*

$3

`ts
emitSerial(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### eventArgs

TEventData\[TEventName\]

$3

Promise\<void\>

$3

EventEmitter.emitSerial

*

$3

`ts
listenerCount(eventNames?): number;
`

$3

#### eventNames?

keyof TEventData | keyof TEventData[]

$3

number

$3

EventEmitter.listenerCount

*

$3

`ts
logIfDebugEnabled(
type,
eventName?,
eventArgs?): void;
`

$3

#### TEventName

TEventName extends PropertyKey

$3

#### type

string

#### eventName?

TEventName

#### eventArgs?

EventArgs

$3

void

*

$3

`ts
off(eventNames, listener): void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

#### TEventListener

TEventListener = EventListener\<TEventData\[TEventName\]\>

$3

#### eventNames

TEventName | TEventName[]

#### listener

TEventListener

$3

void

$3

EventEmitter.off

*

$3

`ts
offAny(listener): void;
`

$3

#### listener

EventAnyListener

$3

void

$3

EventEmitter.offAny

*

$3

`ts
on(
eventNames,
listener,
filter?): (...args) => void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol = keyof TEventData

$3

#### eventNames

TEventName | TEventName[]

#### listener

EventListener\<TEventData\[TEventName\]\>

#### filter?

TEventData\[TEventName\]

$3

`ts
(...args): void;
`

#### Parameters

##### args

...\[\]

#### Returns

void

$3

EventEmitter.on

*

$3

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

$3

#### listener

EventAnyListener

$3

`ts
(...args): void;
`

#### Parameters

##### args

...\[\]

#### Returns

void

$3

EventEmitter.onAny

*

$3

`ts
once(eventName, listener): (...args) => void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

`ts
(...args): void;
`

#### Parameters

##### args

...\[\]

#### Returns

void

$3

EventEmitter.once

$3

### BaseEmitterParamsFields

@xylabs/events

*

### EventEmitter

@xylabs/events

*

Type Parameters

$3

T extends EventData

Properties

$3

`ts
eventData: T;
`

Methods

$3

`ts
clearListeners(eventNames): void;
`

$3

#### eventNames

keyof T | keyof T[]

$3

void

*

$3

`ts
emit(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### eventArgs

T\[TEventName\]

$3

Promise\<void\>

*

$3

`ts
emitSerial(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### eventArgs

T\[TEventName\]

$3

Promise\<void\>

*

$3

`ts
listenerCount(eventNames): number;
`

$3

#### eventNames

keyof T | keyof T[]

$3

number

*

$3

`ts
off(eventNames, listener): void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventNames

TEventName | TEventName[]

#### listener

EventListener\<T\[TEventName\]\>

$3

void

*

$3

`ts
offAny(listener): void;
`

$3

#### listener

Promise\<void\> | EventAnyListener

$3

void

*

$3

`ts
on(eventNames, listener): EventUnsubscribeFunction;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventNames

TEventName | TEventName[]

#### listener

EventListener\<T\[TEventName\]\>

$3

EventUnsubscribeFunction

*

$3

`ts
onAny(listener): EventUnsubscribeFunction;
`

$3

#### listener

EventAnyListener

$3

EventUnsubscribeFunction

*

$3

`ts
once(eventName, listener): EventUnsubscribeFunction;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### listener

EventListener\<T\[TEventName\]\>

$3

EventUnsubscribeFunction

$3

### BaseEmitterParams

@xylabs/events

*

`ts
type BaseEmitterParams = BaseParams;
`

Type Parameters

$3

T extends EmptyObject = EmptyObject

### DebugLogger

@xylabs/events

*

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

$3

string

$3

string

$3

EventName

$3

EventArgs

Returns

void

### DebugOptions

@xylabs/events

*

`ts
type DebugOptions = object;
`

Configure debug options of an instance.

Properties

$3

`ts
optional enabled: boolean;
`

*

$3

`ts
optional logger: DebugLogger;
`

*

$3

`ts
readonly name: string;
`

### EventAnyListener

@xylabs/events

*

`ts
type EventAnyListener = (eventName, eventData) => Promisable;
`

Type Parameters

$3

TEventArgs extends EventArgs = EventArgs

Parameters

$3

EventName

$3

TEventArgs

Returns

Promisable\<void\>

### EventArgs

@xylabs/events

*

`ts
type EventArgs = string | number | object;
`

### EventData

@xylabs/events

*

`ts
type EventData = object;
`

Index Signature

`ts
[key: string | number | symbol]: EventArgs
`

### EventListener

@xylabs/events

*

`ts
type EventListener = (eventData) => Promisable;
`

Type Parameters

$3

TEventArgs extends EventArgs = EventArgs

Parameters

$3

TEventArgs

Returns

Promisable\<void\>

### EventListenerInfo

@xylabs/events

*

`ts
type EventListenerInfo = object;
`

Type Parameters

$3

TEventArgs extends EventArgs = EventArgs

Properties

$3

`ts
optional filter: TEventArgs;
`

*

$3

`ts
listener: EventListener;
`

### EventName

@xylabs/events

*

`ts
type EventName = PropertyKey;
`

### EventUnsubscribeFunction

@xylabs/events

*

`ts
type EventUnsubscribeFunction = () => void;
`

Returns

void

### EventsParams

@xylabs/events

*

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

### MetaEventData

@xylabs/events

*

`ts
type MetaEventData = object;
`

Type Parameters

$3

TEventData extends EventData

Properties

$3

`ts
listenerAdded: object;
`

$3

`ts
optional eventName: keyof TEventData;
`

$3

`ts
listener:
| EventListener
| EventAnyListener;
`

*

$3

`ts
listenerRemoved: object;
`

$3

`ts
optional eventName: keyof TEventData;
`

$3

`ts
listener:
| EventListener
| EventAnyListener;
``

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

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
[npm-badge]: https://img.shields.io/npm/v/@xylabs/events.svg
[npm-link]: https://www.npmjs.com/package/@xylabs/events
[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/events
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/events

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/events/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/events

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/events
[socket-link]: https://socket.dev/npm/package/@xylabs/events