UploadField

Defined in: packages/core/src/fields/upload/types.ts:64

Resolved upload field definition after defaults are applied.

Extends

• BaseField<TCollectionSlug, TFieldMeta>

Type Parameters

TCollectionSlug

TCollectionSlug extends VexResourceSlug = VexResourceSlug

TFieldMeta

TFieldMeta extends BaseFieldMeta = BaseFieldMeta

Properties

accept

accept: string

Defined in: packages/core/src/fields/upload/types.ts:92

Restrict files that can be uploaded by mimeType.

---

admin

admin: FieldAdminConfig<TCollectionSlug>

Defined in: packages/core/src/fields/baseTypes.ts:576

Resolved admin UI configuration with all defaults applied.

Inherited from

BaseField.admin

---

defaultValue?

optional defaultValue?: string[]

Defined in: packages/core/src/fields/upload/types.ts:88

Pre-filled value shown in the admin form when creating a new document.

Overrides

BaseField.defaultValue

---

description?

optional description?: string

Defined in: packages/core/src/fields/baseTypes.ts:585

Semantic description of the field. Used in three places:

1. Helper text rendered below the field input in the admin form UI.
2. As the Zod .meta({ description }) value for form validation.
3. As the JSDoc comment on the generated document interface property.

To write a separate JSDoc comment, use interfaceDescription in addition.

Inherited from

BaseField.description

---

hasMany

hasMany: boolean

Defined in: packages/core/src/fields/upload/types.ts:73

Whether this input accepts multiple files or only one.

---

index?

optional index?: ResolvedFieldIndexConfigInput

Defined in: packages/core/src/fields/baseTypes.ts:589

Convex index name for this field, or the object form for a compound index.

Inherited from

BaseField.index

---

interfaceDescription?

optional interfaceDescription?: string

Defined in: packages/core/src/fields/baseTypes.ts:587

The JSDoc comment on the generated document interface property

Inherited from

BaseField.interfaceDescription

---

interfaceType

interfaceType: string

Defined in: packages/core/src/fields/baseTypes.ts:591

TypeScript type string written to generated document interfaces (e.g. "string", "number", "string[]").

Inherited from

BaseField.interfaceType

---

label

label: string

Defined in: packages/core/src/fields/baseTypes.ts:567

Display label shown in the admin form. Always set — inferred from the field key if not provided.

Inherited from

BaseField.label

---

max?

optional max?: FieldLimit

Defined in: packages/core/src/fields/upload/types.ts:84

Maximum number of files allowed, with its resolved error message.

See

FieldLimit

---

meta

meta: TFieldMeta

Defined in: packages/core/src/fields/baseTypes.ts:592

Inherited from

BaseField.meta

---

min?

optional min?: FieldLimit

Defined in: packages/core/src/fields/upload/types.ts:79

Minimum number of files allowed, with its resolved error message. Absent means no minimum — upload’s resolved min no longer defaults to 0.

See

FieldLimit

---

required

required: boolean

Defined in: packages/core/src/fields/baseTypes.ts:569

Whether this field is required in the database schema.

Inherited from

BaseField.required

---

to

to: string

Defined in: packages/core/src/fields/upload/types.ts:69

---

type

readonly type: "upload"

Defined in: packages/core/src/fields/upload/types.ts:68

Methods

validate()?

optional validate(props): void | Promise<void>

Defined in: packages/core/src/fields/upload/types.ts:94

Server-only async validation with value typed as string[].

Parameters

props

FieldValidateProps<TCollectionSlug, string[]>

Returns

void | Promise<void>

See

FieldValidate

Overrides

BaseField.validate