Skip to main content

Interface: UseMonitorFieldsResult

Defined in: src/hooks/useMonitorFields.ts:63

Result interface for the useMonitorFields hook

Properties​

error?​

optional error?: string;

Defined in: src/hooks/useMonitorFields.ts:65

Error message if loading failed

getFields​

getFields: (monitorType:
  | "cdn-edge-consistency"
  | "dns"
  | "http"
  | "http-header"
  | "http-json"
  | "http-keyword"
  | "http-latency"
  | "http-status"
  | "ping"
  | "port"
  | "replication"
  | "server-heartbeat"
  | "ssl"
  | "websocket-keepalive") => MonitorFieldDefinition[];

Defined in: src/hooks/useMonitorFields.ts:67

Get field definitions for a specific monitor type

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"

Returns​

MonitorFieldDefinition[]

getRequiredFields​

getRequiredFields: (monitorType:
  | "cdn-edge-consistency"
  | "dns"
  | "http"
  | "http-header"
  | "http-json"
  | "http-keyword"
  | "http-latency"
  | "http-status"
  | "ping"
  | "port"
  | "replication"
  | "server-heartbeat"
  | "ssl"
  | "websocket-keepalive") => string[];

Defined in: src/hooks/useMonitorFields.ts:69

Get required fields for a specific monitor type

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"

Returns​

string[]

isFieldRequired​

isFieldRequired: (
    monitorType:
        | "cdn-edge-consistency"
        | "dns"
        | "http"
        | "http-header"
        | "http-json"
        | "http-keyword"
        | "http-latency"
        | "http-status"
        | "ping"
        | "port"
        | "replication"
        | "server-heartbeat"
        | "ssl"
        | "websocket-keepalive",
    fieldName: string
) => boolean;

Defined in: src/hooks/useMonitorFields.ts:71

Check if a field is required for a monitor type

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"

fieldName​

string

Returns​

boolean

isLoaded​

isLoaded: boolean;

Defined in: src/hooks/useMonitorFields.ts:73

Whether field definitions are loaded