Docs / utilities / useFlowstackStatus

useFlowstackStatus

hook

Monitor the backend connection status, latency, and connectivity with optional polling.

import { useFlowstackStatus } from 'flowstack-sdk'

Backend connection monitoring. Optionally polls the backend on an interval and reports connection state and latency.

Signature

const { status, isConnected, latency, error, checkConnection } = useFlowstackStatus(options)

Parameters

ParamTypeNotesDescription
options.pollIntervalnumber—Polling interval in ms (e.g. 30000).
options.autoPollboolean—Whether to poll automatically.

Returns

FieldTypeDescription
status'connected' | 'disconnected' | 'checking'Current connection status.
isConnectedbooleanWhether the backend is reachable.
latencynumber | nullRound-trip latency in ms.
errorstring | nullLast error message.
checkConnection() => Promise<void>Manually trigger a connection check.

Examples

Connection monitoring
const {
  status,          // 'connected' | 'disconnected' | 'checking'
  isConnected,     // boolean
  latency,         // number | null (ms)
  error,           // string | null
  checkConnection, // () => Promise<void>
} = useFlowstackStatus({
  pollInterval: 30000,
  autoPoll: true,
});

See also

useAuth

Source: README.md#useflowstackstatus · Also available in llms-full.txt and registry.json.