API Reference

useConvexR2Upload

Reference for the Nuxt-only Cloudflare R2 upload helper.

useConvexR2Upload uploads files to Cloudflare R2 through the Convex R2 component and then syncs metadata back through Convex.

Import

const { upload, progress, isUploading, error } = useConvexR2Upload(api.r2)

useConvexR2Upload is available as a Nuxt auto-import when convex.r2 is enabled.

Signature

function useConvexR2Upload(api: {
  generateUploadUrl: FunctionReference<'mutation'>
  syncMetadata: FunctionReference<'mutation'>
}, options?: {
  onSuccess?: (key: string, file: File) => void
  onError?: (error: Error) => void
  onProgress?: (progress: { loaded: number, total: number }) => void
}): {
  upload: (file: File) => Promise<string | null>
  isUploading: Readonly<Ref<boolean>>
  progress: Readonly<Ref<number>>
  error: Readonly<Ref<Error | null>>
}

Behavior

Client-only; calling upload() on the server returns null and sets an error
Requests a signed upload URL from generateUploadUrl
Uploads the file with XMLHttpRequest
Calls syncMetadata after the upload succeeds
Exposes byte-level progress through onProgress and the progress ref

Edit this pageorReport an issue

Module Configuration

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

ConvexQuery

Reference for the Nuxt renderless component that wraps useConvexQuery.

useConvexR2Upload

Import

Signature

Behavior

Related pages