VexVersionDocument

Defined in: packages/core/src/documents/types.ts:54

Type for versioned documents returned from Convex queries.

Extends VexDocument with all required version fields: vex_status, vex_publishedId, vex_publishedA. Use this instead of TDocument in versioned collection views to avoid casting fields like row.vex_status as string.

Example

const src = doc.src; // string | undefined, no cast needed
const alt = doc.alt ?? "";

See

TDocument for the base document type with custom shape support

Extends

• VexDocument

Indexable

[key: string]: unknown

Field values defined by the collection schema.

Properties

_creationTime

_creationTime: number

Defined in: packages/core/src/documents/types.ts:23

Unix timestamp (milliseconds) when the document was created.

Inherited from

VexDocument._creationTime

---

_id

_id: string

Defined in: packages/core/src/documents/types.ts:21

Convex document ID string.

Inherited from

VexDocument._id

---

vex_activeVersion?

optional vex_activeVersion?: number

Defined in: packages/core/src/documents/types.ts:58

---

vex_publishedAt?

optional vex_publishedAt?: number

Defined in: packages/core/src/documents/types.ts:57

---

vex_publishedId?

optional vex_publishedId?: string

Defined in: packages/core/src/documents/types.ts:56

---

vex_status

vex_status: "draft" | "published"

Defined in: packages/core/src/documents/types.ts:55