---
title: "API Reference"
description: "Every auto-imported composable, component, and server helper, plus the generated TypeScript reference for each published module."
canonical_url: "https://nuxt-convex-module.dev/api-reference"
---
# API Reference

> Every auto-imported composable, component, and server helper, plus the generated TypeScript reference for each published module.

Two hand-written index pages and the generated TypeDoc output.

- [App Auto-imports](https://nuxt-convex-module.dev/api-reference/auto-imports) — every composable and component auto-imported into pages, components, and composables.
- [Server Auto-imports](https://nuxt-convex-module.dev/api-reference/server-imports) — every helper auto-imported into Nitro server code.
- [Generated Reference](https://nuxt-convex-module.dev/api-reference/reference) — full TypeScript signatures for `client`, `app`, `server`, and each integration subpath.

For prose explanations of the same surface, start with the [Guide](https://nuxt-convex-module.dev/guide/queries).

## Subpath exports

Everything is auto-imported in Nuxt, but each surface is also a real subpath export of `nuxt-convex-module` — for explicit or type-only imports, and for a [plain Vue](https://nuxt-convex-module.dev/guide/plain-vue) app. Entries follow client/server naming, mirroring upstream's `convex/react` and `convex/nextjs` split.

**/client or /vue?** They are the same file. `/client` is the name the Nuxt guide and the generated reference use; `/vue` is its alias, there for a file that reads better with a Vue-flavoured import — most often a Nuxt-less app. Pick one per project.

<table>
<thead>
  <tr>
    <th>
      Import path
    </th>
    
    <th>
      Contents
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        nuxt-convex-module
      </code>
    </td>
    
    <td>
      the Nuxt module (for <code>
        modules: []
      </code>
      
      )
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        nuxt-convex-module/client
      </code>
      
       (alias <code>
        /vue
      </code>
      
      )
    </td>
    
    <td>
      <code>
        ConvexVueClient
      </code>
      
      , <code>
        ConvexClientKey
      </code>
      
      , every composable (<code>
        useQuery
      </code>
      
      , <code>
        useMutation
      </code>
      
      , <code>
        useAction
      </code>
      
      , pagination, upload, …), auth (<code>
        provideConvexAuth
      </code>
      
      , <code>
        useConvexAuth
      </code>
      
      , <code>
        <Authenticated>
      </code>
      
       …), <code>
        usePreloadedQuery
      </code>
      
      , and all public types
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        nuxt-convex-module/server
      </code>
    </td>
    
    <td>
      Nitro/server: <code>
        fetchQuery
      </code>
      
      , <code>
        fetchMutation
      </code>
      
      , <code>
        fetchAction
      </code>
      
      , <code>
        preloadQuery
      </code>
      
      , <code>
        preloadedQueryResult
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        nuxt-convex-module/app
      </code>
    </td>
    
    <td>
      Nuxt app context: <code>
        useAsyncQuery
      </code>
      
      , <code>
        useConvexAsyncQuery
      </code>
      
      , and the <code>
        AsyncQueryReturn
      </code>
      
       / <code>
        AsyncQueryOptions
      </code>
      
       / <code>
        AsyncQueryStatus
      </code>
      
       / <code>
        AsyncQueryData
      </code>
      
       types
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        nuxt-convex-module/clerk/client
      </code>
      
       (alias <code>
        /clerk/vue
      </code>
      
      )
    </td>
    
    <td>
      <code>
        provideConvexAuthFromClerk
      </code>
      
      , <code>
        <ConvexProviderWithClerk>
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        nuxt-convex-module/auth0/client
      </code>
      
       (alias <code>
        /auth0/vue
      </code>
      
      )
    </td>
    
    <td>
      <code>
        provideConvexAuthFromAuth0
      </code>
      
      , <code>
        <ConvexProviderWithAuth0>
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        nuxt-convex-module/better-auth/client
      </code>
      
       (alias <code>
        /better-auth/vue
      </code>
      
      )
    </td>
    
    <td>
      <code>
        useBetterAuth
      </code>
      
      , <code>
        authClient
      </code>
      
      , <code>
        usePreloadedAuthQuery
      </code>
      
      , <code>
        consumeCrossDomainOneTimeToken
      </code>
      
      , <code>
        resolveAuthRedirect
      </code>
      
      , <code>
        <AuthBoundary>
      </code>
      
      , and the <code>
        convexClient
      </code>
      
       / <code>
        crossDomainClient
      </code>
      
       client plugins (re-exported from <code>
        @convex-dev/better-auth/client/plugins
      </code>
      
      )
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        nuxt-convex-module/better-auth/server
      </code>
    </td>
    
    <td>
      Nitro/server: <code>
        convexAuth(event)
      </code>
      
       (auto-imported in server code; import explicitly for the <code>
        ConvexAuthOptions
      </code>
      
       / <code>
        ConvexAuthService
      </code>
      
       types)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        nuxt-convex-module/polar/client
      </code>
      
       (alias <code>
        /polar/vue
      </code>
      
      )
    </td>
    
    <td>
      <code>
        <CheckoutLink>
      </code>
      
      , <code>
        <CustomerPortalLink>
      </code>
    </td>
  </tr>
</tbody>
</table>

The core, Clerk, Auth0 and Polar entries are self-contained and work in a plain Vue app; `/better-auth/*`, `/server` and `/app` rely on Nuxt-provided aliases, runtime config or `#app`, and need Nuxt.


## Sitemap

See the full [sitemap](https://nuxt-convex-module.dev/sitemap.md) for all pages.