Skip to main content

Interface: MonitoringControlEventData

Defined in: shared/types/events.ts:247

Payload for monitoring control events (global monitoring start/stop).

Remarks​

Used to signal global monitoring state changes, such as starting or stopping all monitors. - activeMonitors: Number of active monitors (for stopped events).

  • monitorCount: Number of monitors involved in the operation.
  • reason: Reason for stopping (for stopped events).
  • siteCount: Number of sites involved in the operation.
  • timestamp: The time (in ms since epoch) when the event occurred.

Example​

const event: MonitoringControlEventData = {
    reason: "user",
    activeMonitors: 0,
    siteCount: 3,
    timestamp: Date.now(),
};

Extends​

Properties​

timestamp​

timestamp: number

Defined in: shared/types/events.ts:25

The time (in ms since epoch) when the event occurred.

Inherited from​

BaseEventData.timestamp

activeMonitors?​

readonly optional activeMonitors: number

Defined in: shared/types/events.ts:251

Number of active monitors (for stopped events).

monitorCount?​

readonly optional monitorCount: number

Defined in: shared/types/events.ts:255

Number of monitors involved in the operation.

reason?​

readonly optional reason: "error" | "shutdown" | "user"

Defined in: shared/types/events.ts:262

Reason for stopping (for stopped events).

Remarks​

Can be 'error', 'shutdown', or 'user'.

siteCount?​

readonly optional siteCount: number

Defined in: shared/types/events.ts:266

Number of sites involved in the operation.