Skip to main content

Interface: UseSiteDetailsResult

Defined in: src/hooks/site/useSiteDetails.ts:77

Return type for the useSiteDetails hook containing all state and handlers.

Remarks​

Provides comprehensive site management functionality including monitor selection, monitoring controls, settings management, and analytics integration.

Properties​

activeSiteDetailsTab​

activeSiteDetailsTab: SiteDetailsTab;

Defined in: src/hooks/site/useSiteDetails.ts:80

Currently active tab in the site details view

analytics​

analytics: SiteAnalytics;

Defined in: src/hooks/site/useSiteDetails.ts:83

Comprehensive analytics data for the selected monitor

currentSite​

currentSite: Site;

Defined in: src/hooks/site/useSiteDetails.ts:86

The current site being viewed/managed

handleCheckNow​

handleCheckNow: () => Promise<void>;

Defined in: src/hooks/site/useSiteDetails.ts:89

Trigger an immediate check of the selected monitor

Returns​

Promise<void>

handleIntervalChange​

handleIntervalChange: (e: ChangeEvent<HTMLSelectElement>) => void;

Defined in: src/hooks/site/useSiteDetails.ts:91

Handle changes to the check interval dropdown

Parameters​

e​

ChangeEvent<HTMLSelectElement>

Returns​

void

handleMonitorIdChange​

handleMonitorIdChange: (e: ChangeEvent<HTMLSelectElement>) => void;

Defined in: src/hooks/site/useSiteDetails.ts:93

Handle changes to the monitor selection dropdown

Parameters​

e​

ChangeEvent<HTMLSelectElement>

Returns​

void

handleRemoveMonitor​

handleRemoveMonitor: () => Promise<void>;

Defined in: src/hooks/site/useSiteDetails.ts:95

Remove the selected monitor from the site

Returns​

Promise<void>

handleRemoveSite​

handleRemoveSite: () => Promise<void>;

Defined in: src/hooks/site/useSiteDetails.ts:97

Remove the entire site and all its monitors

Returns​

Promise<void>

handleRetryAttemptsChange​

handleRetryAttemptsChange: (e: ChangeEvent<HTMLInputElement>) => void;

Defined in: src/hooks/site/useSiteDetails.ts:99

Handle changes to the retry attempts input field

Parameters​

e​

ChangeEvent<HTMLInputElement>

Returns​

void

handleSaveInterval​

handleSaveInterval: () => Promise<void>;

Defined in: src/hooks/site/useSiteDetails.ts:101

Save the modified check interval to the database

Returns​

Promise<void>

handleSaveName​

handleSaveName: () => Promise<void>;

Defined in: src/hooks/site/useSiteDetails.ts:103

Save the modified site name to the database

Returns​

Promise<void>

handleSaveRetryAttempts​

handleSaveRetryAttempts: () => Promise<void>;

Defined in: src/hooks/site/useSiteDetails.ts:105

Save the modified retry attempts to the database

Returns​

Promise<void>

handleSaveTimeout​

handleSaveTimeout: () => Promise<void>;

Defined in: src/hooks/site/useSiteDetails.ts:107

Save the modified timeout value to the database

Returns​

Promise<void>

handleStartMonitoring​

handleStartMonitoring: () => Promise<void>;

Defined in: src/hooks/site/useSiteDetails.ts:109

Start monitoring for the selected monitor only

Returns​

Promise<void>

handleStartSiteMonitoring​

handleStartSiteMonitoring: () => Promise<void>;

Defined in: src/hooks/site/useSiteDetails.ts:111

Start monitoring for all monitors in the site

Returns​

Promise<void>

handleStopMonitoring​

handleStopMonitoring: () => Promise<void>;

Defined in: src/hooks/site/useSiteDetails.ts:113

Stop monitoring for the selected monitor only

Returns​

Promise<void>

handleStopSiteMonitoring​

handleStopSiteMonitoring: () => Promise<void>;

Defined in: src/hooks/site/useSiteDetails.ts:115

Stop monitoring for all monitors in the site

Returns​

Promise<void>

handleTimeoutChange​

handleTimeoutChange: (e: ChangeEvent<HTMLInputElement>) => void;

Defined in: src/hooks/site/useSiteDetails.ts:117

Handle changes to the timeout input field

Parameters​

e​

ChangeEvent<HTMLInputElement>

Returns​

void

hasUnsavedChanges​

hasUnsavedChanges: boolean;

Defined in: src/hooks/site/useSiteDetails.ts:120

Whether there are unsaved changes to site/monitor settings

intervalChanged​

intervalChanged: boolean;

Defined in: src/hooks/site/useSiteDetails.ts:122

Whether the check interval has been modified but not saved

isLoading​

isLoading: boolean;

Defined in: src/hooks/site/useSiteDetails.ts:124

Whether the component is in a loading state

isMonitoring​

isMonitoring: boolean;

Defined in: src/hooks/site/useSiteDetails.ts:126

Whether monitoring is currently active for any monitor in the site

localCheckIntervalMs​

localCheckIntervalMs: number;

Defined in: src/hooks/site/useSiteDetails.ts:128

Local copy of check interval (milliseconds) for editing before saving

localName​

localName: string;

Defined in: src/hooks/site/useSiteDetails.ts:130

Local copy of site name for editing before saving

localRetryAttempts​

localRetryAttempts: number;

Defined in: src/hooks/site/useSiteDetails.ts:132

Local copy of retry attempts for editing before saving

localTimeoutSeconds​

localTimeoutSeconds: number;

Defined in: src/hooks/site/useSiteDetails.ts:134

Local copy of timeout (seconds) for editing before saving

retryAttemptsChanged​

retryAttemptsChanged: boolean;

Defined in: src/hooks/site/useSiteDetails.ts:136

Whether the retry attempts value has been modified but not saved

selectedMonitor​

selectedMonitor:
  | Monitor
  | undefined;

Defined in: src/hooks/site/useSiteDetails.ts:138

The currently selected monitor object

selectedMonitorId​

selectedMonitorId: string;

Defined in: src/hooks/site/useSiteDetails.ts:140

ID of the currently selected monitor

setActiveSiteDetailsTab​

setActiveSiteDetailsTab: (tab: SiteDetailsTab) => void;

Defined in: src/hooks/site/useSiteDetails.ts:143

Set the active tab in the site details view

Parameters​

tab​

SiteDetailsTab

Returns​

void

setLocalName​

setLocalName: (name: string) => void;

Defined in: src/hooks/site/useSiteDetails.ts:145

Update the local site name state

Parameters​

name​

string

Returns​

void

setShowAdvancedMetrics​

setShowAdvancedMetrics: (show: boolean) => void;

Defined in: src/hooks/site/useSiteDetails.ts:147

Toggle advanced metrics display in analytics

Parameters​

show​

boolean

Returns​

void

setSiteDetailsChartTimeRange​

setSiteDetailsChartTimeRange: (range: "1h" | "7d" | "24h" | "30d") => void;

Defined in: src/hooks/site/useSiteDetails.ts:149

Set the time range for analytics charts

Parameters​

range​

"1h" | "7d" | "24h" | "30d"

Returns​

void

showAdvancedMetrics​

showAdvancedMetrics: boolean;

Defined in: src/hooks/site/useSiteDetails.ts:151

Whether to show advanced metrics in analytics

siteDetailsChartTimeRange​

siteDetailsChartTimeRange: "1h" | "7d" | "24h" | "30d";

Defined in: src/hooks/site/useSiteDetails.ts:153

Current time range setting for analytics charts

siteExists​

siteExists: boolean;

Defined in: src/hooks/site/useSiteDetails.ts:155

Whether the site exists in the database

timeoutChanged​

timeoutChanged: boolean;

Defined in: src/hooks/site/useSiteDetails.ts:157

Whether the timeout value has been modified but not saved