VexMediaDocument

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

Type for media documents returned from Convex queries.

Extends VexDocument with all required media fields: alt, filename, mimeType, size, storageId, deleted, src (the file URL), and optional width/height. Use this instead of TDocument in media collection views to avoid casting fields like row.original.src 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

---

alt

alt: string

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

Alt text for accessibility and SEO.

---

deleted

deleted: boolean

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

Whether this media item has been soft-deleted.

---

filename

filename: string

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

Original filename of the uploaded file.

---

height?

optional height?: number

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

Image height in pixels (if applicable).

---

mimeType

mimeType: string

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

MIME type (e.g., “image/jpeg”, “application/pdf”).

---

size

size: number

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

File size in bytes.

---

src

src: string

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

URL to the file.

---

storageId

storageId: string

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

Storage adapter ID for the uploaded file.

---

width?

optional width?: number

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

Image width in pixels (if applicable).