convexFileStorage

convexFileStorage(options?): ConvexStorageAdapter

Defined in: packages/file-storage-convex/src/storage.ts:43

Creates a Convex file storage adapter for VexCMS.

Configures the Convex-backed file storage backend and returns a VexStorageAdapter for defineServerConfig’s server.storage.adapters. Media collections are declared on the CLIENT config instead of here — see defineMediaCollection (@vexcms/file-storage-convex/client), which already tags every collection it produces with meta.storageAdapter: "convex".

Parameters

options?

ConvexFileStorageOptions = {}

— Adapter configuration. Every field is optional.

Returns

ConvexStorageAdapter

A VexStorageAdapter ready for defineServerConfig({ server: { storage: { adapters: [...] } } }).

Example

// vex.config.ts (client)
import { defineMediaCollection } from "@vexcms/file-storage-convex/client";
const images = defineMediaCollection({ slug: "images" });
export default defineConfig({ mediaCollections: [images], collections: [posts] });

// vex.config.server.ts (server)
import { convexFileStorage } from "@vexcms/file-storage-convex";
export default defineServerConfig({
  config,
  server: { storage: { adapters: [convexFileStorage()] } },
});