Class VineNativeFile

VineNativeFile represents a platform native File class instance. This type is used to validate file uploads in browser environments where the File API is available.

The file is validated based on type, size, and MIME type constraints. Unlike MultipartFile (used in Node.js), this works with the browser's native File object from file input elements.

Example

const schema = vine.object({
  avatar: vine.file().maxSize('2mb').mimeTypes(['image/jpeg', 'image/png']),
  document: vine.file().minSize('1kb').maxSize('10mb')
})

Example

// From HTML file input
// <input type="file" name="avatar" />
const file = event.target.files[0] // This is a native File instance

Hierarchy (View Summary)

BaseLiteralType<File, File, File>
- VineNativeFile

Index

Constructors

constructor

new VineNativeFile(
options?: Partial<FieldOptions>,
validations?: Validation<any>[],
): VineNativeFile
Creates a new VineNativeFile instance.
Parameters
- Optionaloptions: Partial<FieldOptions>
  Field options like bail mode and nullability
- Optionalvalidations: Validation<any>[]
  Initial set of validations to apply
Returns VineNativeFile
Overrides BaseLiteralType.constructor
- Defined in src/schema/native_file/main.ts:71

Properties

[ITYPE]

"[ITYPE]": File

Define the input type of the schema for TypeScript inference

[OTYPE]

"[OTYPE]": File

The output value type of the field after validation. The property points to a type only and not the real value.

[COTYPE]

"[COTYPE]": File

Type marker for camelCase output type inference

`Optional`dataTypeValidator

dataTypeValidator?: Validation<any>

The validation to use for validating the schema data type. Using a data type validator guards custom rules to only run when the data type validation passes.

Example

class StringSchema extends BaseLiteralType {
  dataTypeValidator = stringDataTypeRule
}

options

options: FieldOptions

Configuration options for this field including bail mode, nullability, and parsing

`Static`rules

rules: {
    maxSize: (
        ...options: [options: { max: number }],
    ) => Validation<{ max: number }>;
    mimeTypes: (
        ...options: [options: { mimeTypes: string[] }],
    ) => Validation<{ mimeTypes: string[] }>;
    minSize: (
        ...options: [options: { min: number }],
    ) => Validation<{ min: number }>;
} = ...

Static collection of all available validation rules for native files

[SUBTYPE]

"[SUBTYPE]": string = 'nativeFile'

The subtype identifier for the literal schema field

[UNIQUE_NAME]

"[UNIQUE_NAME]": string = 'vine.nativeFile'

Unique name identifier for union type resolution

Methods

toJSONSchema

toJSONSchema(): JSONSchema7
Transforms your schema type into JSONSchema7

Returns JSONSchema7
Inherited from BaseLiteralType.toJSONSchema
- Defined in src/schema/base/literal.ts:661

parse

parse(callback: ParseFn): this
Define a method to parse the input value. The method is invoked before any validation and hence you must perform type-checking to know the value you are working it.
Parameters
- callback: ParseFn
Returns this
Inherited from BaseLiteralType.parse
- Defined in src/schema/base/literal.ts:684

use

use(validation: Validation<any> | RuleBuilder): this
Adds a validation rule to the schema's validation chain. Rules are executed in the order they are added.
Parameters
- validation: Validation<any> | RuleBuilder
  The validation rule or rule builder to add
Returns this
This schema instance for method chaining
Example
```
vine.string().use(minLength({ length: 3 }))
vine.number().use(customRule({ strict: true }))
```
Inherited from BaseLiteralType.use
- Defined in src/schema/base/literal.ts:700

bail

bail(state: boolean): VineNativeFile
Enable/disable bail mode for this field. In bail mode, field validations stop after the first error.
Parameters
- state: boolean
  Whether to enable bail mode
Returns VineNativeFile
This schema instance for method chaining
Example
```
vine.string().bail(false) // Continue validation after first error
vine.number().bail(true)  // Stop after first error (default)
```
Inherited from BaseLiteralType.bail
- Defined in src/schema/base/literal.ts:716

optional

optional(): OptionalModifier<VineNativeFile>
Mark the field under validation as optional. An optional field allows both null and undefined values.

Returns OptionalModifier<VineNativeFile>
Inherited from BaseLiteralType.optional
- Defined in src/schema/base/literal.ts:725

nullable

nullable(): NullableModifier<VineNativeFile>
Mark the field under validation to be null. The null value will be written to the output as well.

If optional and nullable are used together, then both undefined and null values will be allowed.

Returns NullableModifier<VineNativeFile>
Inherited from BaseLiteralType.nullable
- Defined in src/schema/base/literal.ts:736

transform

transform<TransformedOutput>(
transformer: Transformer<VineNativeFile, TransformedOutput>,
): TransformModifier<VineNativeFile, TransformedOutput>
Apply transform on the final validated value. The transform method may convert the value to any new datatype.
Type Parameters
- TransformedOutput
Parameters
- transformer: Transformer<VineNativeFile, TransformedOutput>
Returns TransformModifier<VineNativeFile, TransformedOutput>
Inherited from BaseLiteralType.transform
- Defined in src/schema/base/literal.ts:752

[PARSE]

"[PARSE]"(
    propertyName: string,
    refs: RefsStore,
    options: ParserOptions,
): FieldNode & {} & { subtype: string }
Compiles the literal schema type into a compiler node. This method transforms the schema definition into a format that the validation compiler can process.
Parameters
- propertyName: string
  Name of the property being compiled
- refs: RefsStore
  Reference store for the compiler
- options: ParserOptions
  Parser options including camelCase conversion
Returns FieldNode & {} & { subtype: string }
Compiled literal node with subtype information
Inherited from BaseLiteralType.[PARSE]
- Defined in src/schema/base/literal.ts:768

[IS_OF_TYPE]

"[IS_OF_TYPE]"(value: unknown): value is File
Type checker function to determine if a value is a native file. Required for "unionOfTypes" functionality.
Parameters
- value: unknown
  The value to check
Returns value is File
- Defined in src/schema/native_file/main.ts:61

clone

clone(): VineNativeFile
Clones the VineNativeFile schema type. The applied options and validations are copied to the new instance.

Returns VineNativeFile
A cloned instance of this VineNativeFile schema
Overrides BaseLiteralType.clone
- Defined in src/schema/native_file/main.ts:82

minSize

minSize(size: number): VineNativeFile
Enforce the file size to be at least the provided minimum size.
Parameters
- size: number
  Minimum file size in bytes
Returns VineNativeFile
Example
```
vine.file().minSize(1024) // At least 1KB
```
- Defined in src/schema/native_file/main.ts:94

maxSize

maxSize(size: number): VineNativeFile
Limit the maximum file size.
Parameters
- size: number
  Maximum file size in bytes
Returns VineNativeFile
Example
```
vine.file().maxSize(2097152) // Max 2MB
```
- Defined in src/schema/native_file/main.ts:106

mimeTypes

mimeTypes(types: string[]): VineNativeFile
Enforce the file type to be one of the specified MIME types.
Parameters
- types: string[]
  Array of allowed MIME types
Returns VineNativeFile
Example
```
vine.file().mimeTypes(['image/jpeg', 'image/png', 'image/gif'])
```
Example
```
vine.file().mimeTypes(['application/pdf'])
```
- Defined in src/schema/native_file/main.ts:121

Class VineNativeFile

Example

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VineNativeFile

Properties

[ITYPE]

[OTYPE]

[COTYPE]

OptionaldataTypeValidator

Example

options

Staticrules

[SUBTYPE]

[UNIQUE_NAME]

Methods

toJSONSchema

Returns JSONSchema7

parse

Parameters

Returns this

use

Parameters

Returns this

Example

bail

Parameters

Returns VineNativeFile

Example

optional

Returns OptionalModifier<VineNativeFile>

nullable

Returns NullableModifier<VineNativeFile>

meta

Parameters

Returns MetaModifier<VineNativeFile>

transform

Type Parameters

Parameters

Returns TransformModifier<VineNativeFile, TransformedOutput>

[PARSE]

Parameters

Returns FieldNode & {} & { subtype: string }

[IS_OF_TYPE]

Parameters

Returns value is File

clone

Returns VineNativeFile

minSize

Parameters

Returns VineNativeFile

Example

maxSize

Parameters

Returns VineNativeFile

Example

mimeTypes

Parameters

Returns VineNativeFile

Example

Example

Settings

On This Page

`Optional`dataTypeValidator

`Static`rules