API Reference

useConvexController

Reference for the advanced controller used for delayed connection, reconfiguration, and explicit disconnect flows.

useConvexController returns the advanced runtime controller from vue-convex/advanced.

Import

import { useConvexController } from 'vue-convex/advanced'

In Nuxt, the same types and functions are available through #convex/advanced.

Signature

function useConvexController(): {
  options: Readonly<Ref<ResolvedConvexVueOptions>>
  status: Readonly<Ref<'connected' | 'disconnected'>>
  connect: (options: { url: string, clientOptions?: ConvexClientOptions, server?: boolean }) => void
  reconfigure: (options: Partial<{ url: string, clientOptions?: ConvexClientOptions, server?: boolean }>) => void
  disconnect: () => void
  getClient: () => ConvexClient | undefined
  getHttpClient: () => ConvexHttpClient | undefined
}

Behavior

connect() requires a URL
reconfigure() requires that a URL is already configured
disconnect() clears the clients and resets auth state
In the browser, connect() creates both the HTTP client and realtime client

Edit this pageorReport an issue

useConvexAction

Reference for the shared action composable.

useConvexPaginatedQuery

Reference for the client-only paginated query composable.

useConvexController

Import

Signature

Behavior

Related pages