Skip to main content

Function: useDynamicHelpText()

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

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

Custom hook for dynamically loading monitor type help text.

Parametersโ€‹

monitorTypeโ€‹

Monitor type to load help text for.

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

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.