API Reference
useConvexClient
Reference for the advanced helper that returns the active realtime client.
useConvexClient returns the current ConvexClient instance.
Import
import { useConvexClient } from 'vue-convex/advanced'
In Nuxt, the same helper is available from #convex/advanced.
Signature
function useConvexClient(): ConvexClient
Behavior
- Throws when no realtime client is connected
- Intended as an escape hatch when the higher-level composables are not enough