Classservicesv0.6.0

StrictEventEmitter

Typed wrapper around Node.js EventEmitterEventEmitter enforcing tuple payloads per event name.

class StrictEventEmitter<
    TEvents extends SEEventMapLike<TEvents>
> extends EventEmitter

class StrictEventEmitter<
    TEvents extends SEEventMapLike<TEvents>
> extends EventEmitter

Member visibility

Filter class members by access level.

Showing members with Protected visibility and higher.

Methods

addListener()
emit()
eventNamesTyped()
listenerCountTyped()
listeners()
off()
on()
once()
removeListener()
waitFor()

TEvents

Map of event names to readonly tuple payloads

TEvents extends SEEventMapLike<TEvents>

TEvents extends SEEventMapLike<TEvents>

addListener()

Alias of onon for compatibility with Node.js EventEmitter APIs.

public addListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

public addListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

emit()

Emits an event with the strictly typed argument tuple for the event name.

public emit<TEventKey>(
    event: TEventKey,
    args: TEvents[TEventKey]
): boolean

public emit<TEventKey>(
    event: TEventKey,
    args: TEvents[TEventKey]
): boolean

Parameter: event

The event name to emit

Parameter: args

Tuple payload for the event

eventNamesTyped()

Returns the list of event names known to the emitter with the mapped key type.

public eventNamesTyped(): SEEventKey<TEvents>[]

public eventNamesTyped(): SEEventKey<TEvents>[]

listenerCountTyped()

Counts listeners for an event without widening the return type of listenerCountlistenerCount.

public listenerCountTyped<TEventKey>(event: TEventKey): number

public listenerCountTyped<TEventKey>(event: TEventKey): number

Parameter: event

The event name to inspect

listeners()

Retrieves the listener list for a given event with the correct tuple signature.

public listeners<TEventKey>(
    event: TEventKey
): ((...args: TEvents[TEventKey]) => void)[]

public listeners<TEventKey>(
    event: TEventKey
): ((...args: TEvents[TEventKey]) => void)[]

Parameter: event

The event name to inspect

off()

Removes a previously registered listener for the given event.

public off<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

public off<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name whose listener should be removed

Parameter: listener

Callback originally registered for the event

on()

Registers a persistent listener with tuple-safe arguments for the given event.

public on<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

public on<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

once()

Registers a one time listener that is removed after the first invocation.

public once<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

public once<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

removeListener()

Alias of offoff for compatibility with Node.js EventEmitter APIs.

public removeListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

public removeListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name whose listener should be removed

Parameter: listener

Callback originally registered for the event

waitFor()

Waits for an event to be emitted, resolving with the listener arguments tuple once triggered. Supports optional abort signals and timeouts for cancellation semantics.

public async waitFor<TEventKey>(
    event: TEventKey,
    opts?: { signal?: AbortSignal; timeoutMs?: number }
): Promise<TEvents[TEventKey]>

public async waitFor<TEventKey>(
    event: TEventKey,
    opts?: { signal?: AbortSignal; timeoutMs?: number }
): Promise<TEvents[TEventKey]>

Parameter: event

The event name to wait for

Parameter: opts

Optional abort signal or timeout in milliseconds

Classservicesv0.6.0

StrictEventEmitter

Typed wrapper around Node.js EventEmitterEventEmitter enforcing tuple payloads per event name.

class StrictEventEmitter<
    TEvents extends SEEventMapLike<TEvents>
> extends EventEmitter

class StrictEventEmitter<
    TEvents extends SEEventMapLike<TEvents>
> extends EventEmitter

Member visibility

Filter class members by access level.

Showing members with Protected visibility and higher.

TEvents

Map of event names to readonly tuple payloads

TEvents extends SEEventMapLike<TEvents>

TEvents extends SEEventMapLike<TEvents>

addListener()

Alias of onon for compatibility with Node.js EventEmitter APIs.

public addListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

public addListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

emit()

Emits an event with the strictly typed argument tuple for the event name.

public emit<TEventKey>(
    event: TEventKey,
    args: TEvents[TEventKey]
): boolean

public emit<TEventKey>(
    event: TEventKey,
    args: TEvents[TEventKey]
): boolean

Parameter: event

The event name to emit

Parameter: args

Tuple payload for the event

eventNamesTyped()

Returns the list of event names known to the emitter with the mapped key type.

public eventNamesTyped(): SEEventKey<TEvents>[]

public eventNamesTyped(): SEEventKey<TEvents>[]

listenerCountTyped()

Counts listeners for an event without widening the return type of listenerCountlistenerCount.

public listenerCountTyped<TEventKey>(event: TEventKey): number

public listenerCountTyped<TEventKey>(event: TEventKey): number

Parameter: event

The event name to inspect

listeners()

Retrieves the listener list for a given event with the correct tuple signature.

public listeners<TEventKey>(
    event: TEventKey
): ((...args: TEvents[TEventKey]) => void)[]

public listeners<TEventKey>(
    event: TEventKey
): ((...args: TEvents[TEventKey]) => void)[]

Parameter: event

The event name to inspect

off()

Removes a previously registered listener for the given event.

public off<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

public off<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name whose listener should be removed

Parameter: listener

Callback originally registered for the event

on()

Registers a persistent listener with tuple-safe arguments for the given event.

public on<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

public on<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

once()

Registers a one time listener that is removed after the first invocation.

public once<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

public once<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

removeListener()

Alias of offoff for compatibility with Node.js EventEmitter APIs.

public removeListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

public removeListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name whose listener should be removed

Parameter: listener

Callback originally registered for the event

waitFor()

Waits for an event to be emitted, resolving with the listener arguments tuple once triggered. Supports optional abort signals and timeouts for cancellation semantics.

public async waitFor<TEventKey>(
    event: TEventKey,
    opts?: { signal?: AbortSignal; timeoutMs?: number }
): Promise<TEvents[TEventKey]>

public async waitFor<TEventKey>(
    event: TEventKey,
    opts?: { signal?: AbortSignal; timeoutMs?: number }
): Promise<TEvents[TEventKey]>

Parameter: event

The event name to wait for

Parameter: opts

Optional abort signal or timeout in milliseconds