Donation Alerts events client that manages multiple users and allows listening to various events such as donations, goal updates, and poll updates.

The EventsClient acts as a central manager for event subscriptions. Each user tracked by the client operates within its own UserEventsClient instance. This class simplifies handling multiple users while maintaining individual event subscription control.

Hierarchy

  • EventEmitter
    • EventsClient

Constructors

Properties

onConnect: EventBinder<[userId: number]> = ...

Fires when a user's client successfully connects to the Centrifugo server.

onDisconnect: EventBinder<[userId: number, reason: string, reconnect: boolean]> = ...

Fires when a user's client disconnected from the Centrifugo server.

Methods

  • Type Parameters

    • Args extends any[]

    Parameters

    • event: EventBinder<Args>
    • listener: EventHandler<Args>

    Returns Listener

  • Type Parameters

    • Args extends any[]

    Parameters

    • event: EventBinder<Args>
    • listener: EventHandler<Args>

    Returns Listener

  • Type Parameters

    • Args extends any[]

    Returns EventBinder<Args>

  • Parameters

    • id: Listener

    Returns void

  • Type Parameters

    • Args extends any[]

    Parameters

    • Optionalevent: EventBinder<Args>
    • Optionallistener: EventHandler<Args>

    Returns void

  • Unregisters a user and removes their listeners and event subscriptions.

    Parameters

    Returns Promise<void>

    If the user's client is not actively subscribed to channels, the WebSocket connection will be closed.