file

Создаёт схему файла.

Класс File недоступен по умолчанию в Node.js v18 и ниже.

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

Дженерики

• TMessage extends ErrorMessage<FileIssue> | undefined

Параметры

• message TMessage

Объяснение

С помощью file вы можете проверять тип данных входного значения. Если входное значение не является файлом, вы можете использовать message для настройки сообщения об ошибке.

Возвращаемое значение

• Schema FileSchema<TMessage>

Примеры

Следующие примеры показывают, как можно использовать file.

Схема изображения

Схема для валидации изображения.

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.')
);

Связанное

Следующие API можно комбинировать с file.

Схемы

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

Методы

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

Действия

check, brand, description, flavor, guard, maxSize, metadata, mimeType, minSize, notSize, rawCheck, rawTransform, readonly, size, title, transform

Утилиты

entriesFromList, isOfKind, isOfType