Type Alias SenseApiClientEventTypes

Defines the event types for the SenseApiClient.

type SenseApiClientEventTypes = {
realtimeUpdate: [monitorId: number, payload: RealtimePayload];
sessionChanged: [session: Session | undefined];
}

Properties

realtimeUpdate: [monitorId: number, payload: RealtimePayload]

Event emitted when a real-time update is received.

The ID of the monitor that sent the update.

The real-time update payload.

sessionChanged: [session: Session | undefined]

Event emitted when the session changes.

You should subscribe to this event and persist the session object whenever it changes.

The new session object or undefined if session was cleared.