Skip to main content

Function: getSiteDisplayStatus()

function getSiteDisplayStatus(site: SiteForStatus):
    | "unknown"
    | "degraded"
    | "down"
    | "paused"
    | "pending"
    | "up"
    | "mixed";

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

Determines the display status for a site, considering both operational and monitoring states.

Parameters​

site​

SiteForStatus

The SiteForStatus object representing the site to evaluate.

Returns​

"unknown" | "degraded" | "down" | "paused" | "pending" | "up" | "mixed"

"unknown" if there are no monitors.

Remarks​

This is the primary function for determining the status to display in the UI.

Example​

const displayStatus = getSiteDisplayStatus(site);
// displayStatus: "up" | "down" | "pending" | "paused" | "mixed" | "unknown"