Skip to main content

Function: calculateSiteMonitoringStatus()

calculateSiteMonitoringStatus(site: SiteForStatus): "stopped" | "running" | "partial"

Defined in: shared/utils/siteStatus.ts:65

Calculates the overall monitoring state for a site based on its monitors.

Parameters​

site​

SiteForStatus

The SiteForStatus object representing the site to evaluate.

Returns​

"stopped" | "running" | "partial"

The monitoring state: "running", "stopped", or "partial".

Remarks​

The monitoring state reflects whether all, some, or none of the site's monitors are actively monitoring.

  • Returns "running" if all monitors are actively monitoring.
  • Returns "stopped" if no monitors are actively monitoring or if there are no monitors.
  • Returns "partial" if some monitors are monitoring and some are not.

Example​

const status = calculateSiteMonitoringStatus(site);
// status: "running" | "stopped" | "partial"