useConvexStorage

useConvexStorage gives you the low-level storage primitives after the storage feature is configured.

Import

const storage = useConvexStorage()

import { useConvexStorage } from 'vue-convex/storage'

Signature

function useConvexStorage(): {
  generateUploadUrl: () => Promise<string>
  getUrl: (storageId: string) => Ref<string | null>
  remove: (storageId: string) => Promise<void>
}

Setup requirements

In Nuxt, enable convex.storage: true.

In standalone Vue, install convexVueStorage:

app.use(convexVueStorage, {
  generateUploadUrl: api.storage.generateUploadUrl,
  getUrl: api.storage.getUrl,
  remove: api.storage.remove,
})

Behavior

• generateUploadUrl() calls the configured mutation through the realtime client
• getUrl(storageId) returns a reactive ref backed by a live query
• remove(storageId) calls the configured delete mutation

Related pages

• File Storage
• useConvexUpload