Skip to content

VexDocument

Defined in: packages/core/src/api/convex.ts:22

Base type for all VexCMS documents as returned from Convex queries.

All documents include the Convex system fields _id and _creationTime, plus whatever field values are defined in the collection’s schema.

Framework adapters use this as the initialData type in view component props — the actual field values are accessed via string keys.

const title = typeof doc.title === "string" ? doc.title : "";

vexConvexApi for the query functions that return this type

[key: string]: unknown

Field values defined by the collection schema.

_creationTime: number

Defined in: packages/core/src/api/convex.ts:26

Unix timestamp (milliseconds) when the document was created.


_id: string

Defined in: packages/core/src/api/convex.ts:24

Convex document ID string.