API Reference

Look up the public API surface for nuxt-convex and vue-convex.

Use this section for precise lookup. These pages document the public config keys, aliases, composables, components, and feature entrypoints that ship from this repo.

Shared Vue runtime

useConvexQuery
useConvexQueries
useConvexMutation
useConvexAction
useConvexPaginatedQuery
useConvexAuth
useConvexConnectionState

Advanced Vue entrypoint

useConvexController
useConvexClient
useConvexHttpClient

Storage entrypoint

useConvexStorage
useConvexUpload

Nuxt-only surface

Module configuration
Virtual modules
useConvexR2Upload
ConvexQuery
ConvexPaginatedQuery

How to use this section

Read the Vue Guide or Nuxt Module for walkthroughs
Use this section when you need exact signatures, defaults, or behavior notes

Edit this pageorReport an issue

Realtime and SSR

Understand how useConvexQuery moves from server fetch to client subscription, and why paginated queries stay client-only.

Module Configuration

Reference for the public convex module key exposed by nuxt-convex.