RTCForge API Reference v1.1.1
    Preparing search index...

    Class EventEmitter<Events>

    A lightweight, type-safe event emitter.

    The Events type parameter maps each event name to the tuple of argument types its listeners receive, so on, once, off, and emit are all checked against that map at compile time.

    Listeners registered for the same event fire in registration order. During emit the listener list is snapshotted, so adding or removing listeners inside a handler does not affect the current dispatch. All mutating methods return this for chaining.

    const bus = new EventEmitter<{ ready: []; data: [payload: string] }>()
    bus.on('data', (payload) => console.log(payload))
    bus.once('ready', () => console.log('ready once'))
    bus.emit('ready')
    bus.emit('data', 'hello')

    Type Parameters

    • Events extends Record<string, unknown[]>

      Record mapping each event name to the tuple of arguments passed to its listeners.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    emit listenerCount off on once removeAllListeners

    Constructors

    • Type Parameters

      • Events extends Record<string, unknown[]>

        Record mapping each event name to the tuple of arguments passed to its listeners.

      Returns EventEmitter<Events>

    Methods

    • Synchronously invokes every listener registered for event, in registration order.

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K

        The event name to emit.

      • ...args: Events[K]

        The argument tuple to pass to each listener, matching Events[event].

      Returns boolean

      true if at least one listener was invoked, false if there were none.

      The listener list is snapshotted before dispatch, so mutations made by handlers take effect only on subsequent emissions. Listeners are isolated: if one throws, the remaining listeners still run and the error is surfaced via console.error rather than swallowed silently (consistent with LocalMessageBus).

    • Returns the number of listeners currently registered for event.

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K

        The event name to count listeners for.

      Returns number

      The count of registered listeners (0 if none).

    • Removes a previously registered listener for event.

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K

        The event name the listener was registered for.

      • listener: (...args: Events[K]) => void

        The exact function reference passed to on or once.

      Returns this

      This emitter, for chaining.

      If the listener is not currently registered, this is a no-op. Only the first matching registration is removed.

    • Registers a listener that is invoked every time event is emitted.

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K

        The event name to listen for.

      • listener: (...args: Events[K]) => void

        Callback invoked with the event's argument tuple.

      Returns this

      This emitter, for chaining.

    • Registers a listener that is invoked at most once: it is removed automatically before being called the first time event is emitted.

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • event: K

        The event name to listen for.

      • listener: (...args: Events[K]) => void

        Callback invoked with the event's argument tuple on the next emission.

      Returns this

      This emitter, for chaining.

      Remove a pending one-time listener by passing the same function reference to off.

    • Removes listeners for a single event, or for all events.

      Parameters

      • Optionalevent: keyof Events

        The event name to clear; if omitted, listeners for every event are removed.

      Returns this

      This emitter, for chaining.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods