API Reference
Virtual Modules
Reference for the Nuxt-only aliases created by nuxt-convex.
nuxt-convex creates virtual modules so Nuxt app code can import the public runtime surface without reaching into generated or build directories directly.
Always available
| Import | What it exposes |
|---|---|
#convex | The shared root composables and auth renderless components |
#convex/advanced | The advanced controller and raw client helpers |
#convex/api | The generated Convex api, internal, and components exports |
Available when storage: true
| Import | What it exposes |
|---|---|
#convex/storage | The shared storage helpers from vue-convex/storage |
Available when r2: true
There is no R2-specific virtual module. Enabling r2: true only adds the useConvexR2Upload auto-import.
Example
app/pages/tasks.vue
import { api } from '#convex/api'
const { data } = useConvexQuery(api.tasks.list, { userId: 'demo' })