Native File Type

The nativeFile schema type in VineJS enables you to validate uploaded files, whether they come from browser-based form submissions (FormData) or are handled as files on the server using Node.js. This type ensures that files meet specific criteria such as type, size, and presence, providing robust validation for both client and server environments.

import vine from '@vinejs/vine'

const schema = vine.object({
  avatar: vine.nativeFile()
})

Using the following modifiers, you may mark the field as optional or nullable.

{
  avatar: vine.nativeFile().nullable()
}

{
  avatar: vine.nativeFile().optional()
}

Defining error message

You may define custom error messages for the following file-based rules.

const messages = {
  'nativeFile': 'The {{ field }} field must be a valid file',
  'nativeFile.minSize': 'The {{ field }} field must be at least {{ min }} bytes in size',
  'nativeFile.maxSize': 'The {{ field }} field must not exceed {{ max }} bytes in size',
  'nativeFile.mimeTypes': 'The {{ field }} field must be one of the following mime types: {{ mimeTypes }}',
}

vine.messagesProvider = new SimpleMessagesProvider(messages)

Validations

Following is the list of validation rules you can apply on a file.

minSize

Enforces that the uploaded file must have a size greater than or equal to the specified minimum value (in bytes).

import vine from '@vinejs/vine'

const schema = vine.object({
    avatar: vine.nativeFile().minSize(1024) // Minimum size: 1 KB
})

maxSize

Enforces that the uploaded file must not exceed the specified maximum size (in bytes).

import vine from '@vinejs/vine'

const schema = vine.object({
    avatar: vine.nativeFile().maxSize(1024 * 1024) // Maximum size: 1 MB
})

mimeTypes

Restricts the uploaded file to specific MIME types. The mimeTypes method accepts an array of allowed MIME type strings.

import vine from '@vinejs/vine'

const schema = vine.object({
    avatar: vine.nativeFile().mimeTypes(['image/png', 'image/jpeg'])
})