Advanced

API Surface

Generated reference of auto-imported composables, server helpers, and global auth components.

This page is generated from module entrypoints and runtime component files.

Source of truth:

This reference answers:

Which APIs are auto-imported?
What is each API for?
Where is the best guide for examples and deeper usage?

Regenerate this page with:

node scripts/generate-api-surface.mjs

Composable Auto-Imports

Name	Kind	Purpose	Learn More
`createPermissions`	Factory	Builds a typed permission API for route/UI guards and capability checks.	Guide
`defineSharedConvexQuery`	Helper	Auto-imported runtime API provided by this module.	Guide
`deleteFromPaginatedQuery`	Helper	Optimistically removes an item from a paginated query cache.	Guide
`deleteFromQuery`	Helper	Optimistically removes an item from a regular query cache.	Guide
`insertAtBottomIfLoaded`	Helper	Optimistically inserts an item at the end of paginated data when loaded.	Guide
`insertAtPosition`	Helper	Optimistically inserts an item at a custom position in paginated data.	Guide
`insertAtTop`	Helper	Optimistically inserts an item at the top of paginated data.	Guide
`setQueryData`	Helper	Replaces cached query data with a new value.	Guide
`updateAllQueries`	Helper	Applies an updater across multiple cached query results.	Guide
`updateInPaginatedQuery`	Helper	Auto-imported runtime API provided by this module.	Guide
`updateQuery`	Helper	Applies an updater to one cached query result.	Guide
`useConvex`	Composable	Gives direct access to the underlying Convex client.	Guide
`useConvexAction`	Composable	Runs Convex actions with reactive status and error handling.	Guide
`useConvexAuth`	Composable	Tracks auth state and user/session information in Nuxt.	Guide
`useConvexCall`	Composable	Auto-imported runtime API provided by this module.	Guide
`useConvexConnectionState`	Composable	Observes live WebSocket connection state to Convex.	Guide
`useConvexFileUpload`	Composable	Uploads files to Convex storage with progress tracking.	Guide
`useConvexMutation`	Composable	Runs Convex mutations with status, errors, and optimistic hooks.	Guide
`useConvexPaginatedQuery`	Composable	Fetches and paginates query results with real-time updates.	Guide
`useConvexQuery`	Composable	Fetches reactive query data with SSR and subscription support.	Guide
`useConvexStorageUrl`	Composable	Resolves Convex file storage IDs to usable URLs.	Guide
`useConvexUploadQueue`	Composable	Queues and coordinates concurrent file uploads.	Guide

Server Auto-Imports

Name	Kind	Purpose	Learn More
`serverConvexAction`	Server helper	Runs a Convex action from server routes/handlers.	Guide
`serverConvexClearAuthCache`	Server helper	Clears cached auth token state used by server calls.	Guide
`serverConvexMutation`	Server helper	Runs a Convex mutation from server routes/handlers.	Guide
`serverConvexQuery`	Server helper	Runs a Convex query from server routes/handlers.	Guide

Global Auth Components

Name	Kind	Purpose	Learn More
`<ConvexAuthenticated>`	Component	Renders slot content only for authenticated users.	Guide
`<ConvexAuthError>`	Component	Renders slot content when auth resolves with an error.	Guide
`<ConvexAuthLoading>`	Component	Renders slot content while auth state is still loading.	Guide
`<ConvexUnauthenticated>`	Component	Renders slot content only for signed-out users.	Guide

Module Configuration

Complete reference for all nuxt.config.ts convex options.

Protected Dashboard

Protect a dashboard page with definePageMeta and role checks.