UploadField
Defined in: packages/core/src/fields/upload/types.ts:58
Resolved upload field definition after defaults are applied.
Extends
Section titled “Extends”BaseField<TFieldMeta>
Type Parameters
Section titled “Type Parameters”TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends BaseFieldMeta = BaseFieldMeta
Properties
Section titled “Properties”accept
Section titled “accept”accept:
string
Defined in: packages/core/src/fields/upload/types.ts:82
Restrict files that can be uploaded by mimeType.
admin:
FieldAdminConfig
Defined in: packages/core/src/fields/baseTypes.ts:243
Resolved admin UI configuration with all defaults applied.
Inherited from
Section titled “Inherited from”defaultValue?
Section titled “defaultValue?”
optionaldefaultValue?:string[]
Defined in: packages/core/src/fields/upload/types.ts:78
Pre-filled value shown in the admin form when creating a new document.
Overrides
Section titled “Overrides”description?
Section titled “description?”
optionaldescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:252
Semantic description of the field. Used in three places:
- Helper text rendered below the field input in the admin form UI.
- As the Zod
.meta({ description })value for form validation. - As the JSDoc comment on the generated document interface property.
To write a separate JSDoc comment, use interfaceDescription in addition.
Inherited from
Section titled “Inherited from”hasMany
Section titled “hasMany”hasMany:
boolean
Defined in: packages/core/src/fields/upload/types.ts:66
Whether this input accepts multiple files or only one.
index?
Section titled “index?”
optionalindex?:string
Defined in: packages/core/src/fields/baseTypes.ts:256
Convex index name for this field.
Inherited from
Section titled “Inherited from”interfaceDescription?
Section titled “interfaceDescription?”
optionalinterfaceDescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:254
The JSDoc comment on the generated document interface property
Inherited from
Section titled “Inherited from”BaseField.interfaceDescription
interfaceType
Section titled “interfaceType”interfaceType:
string
Defined in: packages/core/src/fields/baseTypes.ts:258
TypeScript type string written to generated document interfaces (e.g. "string", "number", "string[]").
Inherited from
Section titled “Inherited from”label:
string
Defined in: packages/core/src/fields/baseTypes.ts:234
Display label shown in the admin form. Always set — inferred from the field key if not provided.
Inherited from
Section titled “Inherited from”
optionalmax?:number
Defined in: packages/core/src/fields/upload/types.ts:74
The max number of files allowed.
meta:
TFieldMeta
Defined in: packages/core/src/fields/baseTypes.ts:259
Inherited from
Section titled “Inherited from”min:
number
Defined in: packages/core/src/fields/upload/types.ts:70
The min number of files allowed.
required
Section titled “required”required:
boolean
Defined in: packages/core/src/fields/baseTypes.ts:236
Whether this field is required in the database schema.
Inherited from
Section titled “Inherited from”to:
string
Defined in: packages/core/src/fields/upload/types.ts:62
readonlytype:"upload"
Defined in: packages/core/src/fields/upload/types.ts:61