Skip to main content

Function: useDynamicHelpText()

function useDynamicHelpText(
monitorType:
| "cdn-edge-consistency"
| "dns"
| "http"
| "http-header"
| "http-json"
| "http-keyword"
| "http-latency"
| "http-status"
| "ping"
| "port"
| "replication"
| "server-heartbeat"
| "ssl"
| "websocket-keepalive"
): DynamicHelpTextResult;

Defined in: src/hooks/useDynamicHelpText.ts:84

Custom hook for dynamically loading monitor type help text.

Parametersโ€‹

monitorTypeโ€‹

| "cdn-edge-consistency" | "dns" | "http" | "http-header" | "http-json" | "http-keyword" | "http-latency" | "http-status" | "ping" | "port" | "replication" | "server-heartbeat" | "ssl" | "websocket-keepalive"

Monitor type to load help text for.

Returnsโ€‹

DynamicHelpTextResult

Object containing help text data and loading state.

Remarksโ€‹

Provides monitor-specific help text with automatic loading state management. Handles cancellation of pending requests on unmount or monitor type changes using AbortController for proper cleanup.

Seeโ€‹

getMonitorHelpTexts for the IPC-backed helper powering this hook.