convexFileStorage

convexFileStorage(options): ConvexStorageAdapter

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

Creates a Convex file storage adapter for VexCMS.

Processes media collections (adds required fields, validates), configures Convex file storage backend, and returns a VexStorageAdapter. Every collection is tagged with meta.storageAdapterName: "convex".

Parameters

options

ConvexFileStorageOptions

— Adapter configuration. mediaCollections is required.

Returns

ConvexStorageAdapter

A VexStorageAdapter ready for defineConfig({ storageAdapters: [ ... ] }).

Example

import { convexFileStorage, defineMediaCollection } from "@vexcms/file-storage-convex";

const images = defineMediaCollection({
  slug: "images",
  fields: { alt: text({ required: true }) },
});

export default defineConfig({
  storageAdapters: [convexFileStorage({ mediaCollections: [images] })],
  collections: [posts],
});