file

Creates a file schema.

The File class is not available by default in Node.js v18 and below.

const Schema = v.file<TMessage>(message);

Generics

• TMessage extends ErrorMessage<FileIssue> | undefined

Parameters

• message TMessage

Explanation

With file you can validate the data type of the input. If the input is not a file, you can use message to customize the error message.

Returns

• Schema FileSchema<TMessage>

Examples

The following examples show how file can be used.

Image schema

Schema to validate an image.

const ImageSchema = v.pipe(
  v.file('Please select an image file.'),
  v.mimeType(['image/jpeg', 'image/png'], 'Please select a JPEG or PNG file.'),
  v.maxSize(1024 * 1024 * 10, 'Please select a file smaller than 10 MB.')
);

Related

The following APIs can be combined with file.

Schemas

• array,
• intersect,
• lazy,
• looseObject,
• looseTuple,
• map,
• nonNullable,
• nonNullish,
• nonOptional,
• nullable,
• nullish,
• object,
• objectWithRest,
• optional,
• record,
• set,
• strictObject,
• strictTuple,
• tuple,
• tupleWithRest,
• union

Methods

• config,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• parser,
• pipe,
• safeParse,
• safeParser

Actions

• check,
• brand,
• maxSize,
• mimeType,
• minSize,
• notSize,
• rawCheck,
• rawTransform,
• readonly,
• size,
• transform