API Reference

useConvexConnectionState

Reference for the shared composable that reflects the realtime connection state.

useConvexConnectionState exposes the current Convex realtime connection state.

Import

Nuxt

const { state, isConnected } = useConvexConnectionState()

Vue

import { useConvexConnectionState } from 'vue-convex'

function useConvexConnectionState(): {
  state: Readonly<Ref<ConnectionState | null>>
  isConnected: ComputedRef<boolean>
}

Returns null when no realtime client is connected
isConnected maps to state.value?.isWebSocketConnected
Tracks connection changes after connect(), reconfigure(), and disconnect()

useConvexQueries

Reference for subscribing to multiple reactive Convex queries at once.

useConvexClient

Reference for the advanced helper that returns the active realtime client.