Skip to main content

Interface: UseSiteDetailsResult

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

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:69

Currently active tab in the site details view


analyticsโ€‹

analytics: SiteAnalytics

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

Comprehensive analytics data for the selected monitor


currentSiteโ€‹

currentSite: Site

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

The current site being viewed/managed


handleCheckNow()โ€‹

handleCheckNow: () => Promise<void>

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

Trigger an immediate check of the selected monitor

Returnsโ€‹

Promise<void>


handleIntervalChange()โ€‹

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

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

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:82

Handle changes to the monitor selection dropdown

Parametersโ€‹

eโ€‹

ChangeEvent<HTMLSelectElement>

Returnsโ€‹

void


handleRemoveMonitor()โ€‹

handleRemoveMonitor: () => Promise<void>

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

Remove the selected monitor from the site

Returnsโ€‹

Promise<void>


handleRemoveSite()โ€‹

handleRemoveSite: () => Promise<void>

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

Remove the entire site and all its monitors

Returnsโ€‹

Promise<void>


handleRetryAttemptsChange()โ€‹

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

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

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:90

Save the modified check interval to the database

Returnsโ€‹

Promise<void>


handleSaveName()โ€‹

handleSaveName: () => Promise<void>

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

Save the modified site name to the database

Returnsโ€‹

Promise<void>


handleSaveRetryAttempts()โ€‹

handleSaveRetryAttempts: () => Promise<void>

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

Save the modified retry attempts to the database

Returnsโ€‹

Promise<void>


handleSaveTimeout()โ€‹

handleSaveTimeout: () => Promise<void>

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

Save the modified timeout value to the database

Returnsโ€‹

Promise<void>


handleStartMonitoring()โ€‹

handleStartMonitoring: () => Promise<void>

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

Start monitoring for the selected monitor only

Returnsโ€‹

Promise<void>


handleStartSiteMonitoring()โ€‹

handleStartSiteMonitoring: () => Promise<void>

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

Start monitoring for all monitors in the site

Returnsโ€‹

Promise<void>


handleStopMonitoring()โ€‹

handleStopMonitoring: () => Promise<void>

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

Stop monitoring for the selected monitor only

Returnsโ€‹

Promise<void>


handleStopSiteMonitoring()โ€‹

handleStopSiteMonitoring: () => Promise<void>

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

Stop monitoring for all monitors in the site

Returnsโ€‹

Promise<void>


handleTimeoutChange()โ€‹

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

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

Handle changes to the timeout input field

Parametersโ€‹

eโ€‹

ChangeEvent<HTMLInputElement>

Returnsโ€‹

void


hasUnsavedChangesโ€‹

hasUnsavedChanges: boolean

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

Whether there are unsaved changes to site/monitor settings


intervalChangedโ€‹

intervalChanged: boolean

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

Whether the check interval has been modified but not saved


isLoadingโ€‹

isLoading: boolean

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

Whether the component is in a loading state


isMonitoringโ€‹

isMonitoring: boolean

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

Whether monitoring is currently active for any monitor in the site


localCheckIntervalโ€‹

localCheckInterval: number

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

Local copy of check interval for editing before saving


localNameโ€‹

localName: string

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

Local copy of site name for editing before saving


localRetryAttemptsโ€‹

localRetryAttempts: number

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

Local copy of retry attempts for editing before saving


localTimeoutโ€‹

localTimeout: number

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

Local copy of timeout for editing before saving


retryAttemptsChangedโ€‹

retryAttemptsChanged: boolean

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

Whether the retry attempts value has been modified but not saved


selectedMonitorโ€‹

selectedMonitor: Monitor | undefined

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

The currently selected monitor object


selectedMonitorIdโ€‹

selectedMonitorId: string

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

ID of the currently selected monitor


setActiveSiteDetailsTab()โ€‹

setActiveSiteDetailsTab: (tab: SiteDetailsTab) => void

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

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:134

Update the local site name state

Parametersโ€‹

nameโ€‹

string

Returnsโ€‹

void


setShowAdvancedMetrics()โ€‹

setShowAdvancedMetrics: (show: boolean) => void

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

Toggle advanced metrics display in analytics

Parametersโ€‹

showโ€‹

boolean

Returnsโ€‹

void


setSiteDetailsChartTimeRange()โ€‹

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

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

Set the time range for analytics charts

Parametersโ€‹

rangeโ€‹

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

Returnsโ€‹

void


showAdvancedMetricsโ€‹

showAdvancedMetrics: boolean

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

Whether to show advanced metrics in analytics


siteDetailsChartTimeRangeโ€‹

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

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

Current time range setting for analytics charts


siteExistsโ€‹

siteExists: boolean

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

Whether the site exists in the database


timeoutChangedโ€‹

timeoutChanged: boolean

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

Whether the timeout value has been modified but not saved