Перейти к основному содержимому

Встроенные валидаторы

Все встроенные валидаторы — фабрики из @reformer/core/validators. Каждая возвращает чистое правило поля (Rule<TField>) и передаётся в массив оператора validate(sig, [...]) схемы валидации: validate(model.$.email, [required(), email()]).

Схема валидации — отдельная функция defineValidation(({ model }) => …) из @reformer/core/validation; схема формы (узлы, JSON-документ) правил не несёт. Правила живут в этой функции, подключаются к сборке createForm({ validation }) и прогоняются по требованию — bundle.validate(), bundle.submission.submit(handler), шаг потока (подробнее — Обзор валидации).

import { defineValidation, validate } from '@reformer/core/validation';
import { required, email, minLength } from '@reformer/core/validators';

type ContactForm = { name: string; email: string };

const contactValidation = defineValidation<ContactForm>(({ model }) => {
  validate(model.$.name, [required(), minLength(2)]);
  validate(model.$.email, [required(), email()]);
});

Снипеты ниже показывают отдельные фабрики — каждый вызов validate(...) подразумевается внутри такой defineValidation, где оператор validate уже в области видимости.

Общие правила:

  • Пустые значения пропускаются. '', null, undefined (а для длины/чисел/дат — и невалидные значения) считаются валидными. Обязательность проверяет отдельная фабрика required().
  • Опции { code, params } (RuleOptions). Текста у правила нет. Свой code заменяет встроенный (min(18, { code: 'age.min' }) даст замечание { code: 'age.min', params: { min: 18, actual } }), а params добавляют значения для текста. Текст находится по коду: словарь формы defineIssueMessages → словарь локали → встроенный английский (см. Тексты замечаний).
  • Omnibus number() удалён. Числовые проверки собираются из отдельных фабрик (isNumber(), integer(), min(), …).

Общие​

required(options?)​

Поле должно быть заполнено. Пустыми считаются null, undefined, '', [] (пустой массив), а для boolean — любое значение, кроме true (обязательный чекбокс).

import { required } from '@reformer/core/validators';

validate(model.$.email, [required()]);
// Замечание: { code: 'required' }
validate(model.$.agreeToTerms, [required({ code: 'agreeToTerms.required' })]);
// Замечание: { code: 'agreeToTerms.required' } — свой код поля

pattern(regex, options?)​

Значение должно соответствовать регулярному выражению.

import { pattern } from '@reformer/core/validators';

validate(model.$.code, [pattern(/^[A-Z]+$/)]);
// Ошибка: { code: 'pattern', params: { pattern: '^[A-Z]+$' } }

email(options?)​

Формат email (упрощённый regex ^[^\s@]+@[^\s@]+\.[^\s@]+$).

import { required, email } from '@reformer/core/validators';

validate(model.$.email, [required(), email()]);
// Ошибка: { code: 'email' }

url(options?)​

Формат URL. Дополнительные опции: requireProtocol (требовать http(s)://) и allowedProtocols (ограничить набор протоколов).

import { url } from '@reformer/core/validators';

validate(model.$.website, [url()]);
validate(model.$.homepage, [url({ requireProtocol: true, allowedProtocols: ['https'] })]);
// Ошибки: { code: 'url' } либо { code: 'url_protocol', params: { allowedProtocols } }

phone(options?)​

Номер телефона. Формат задаётся опцией format типа PhoneFormat:

type PhoneFormat = 'international' | 'ru' | 'us' | 'any'; // по умолчанию 'any'
import { required, phone } from '@reformer/core/validators';

validate(model.$.phone, [required(), phone({ format: 'ru' })]);
// Ошибка: { code: 'phone', params: { format: 'ru' } }

Длина строки​

Работают со строкой или массивом (проверяется value.length).

minLength(n, options?) · maxLength(n, options?)​

import { minLength, maxLength } from '@reformer/core/validators';

validate(model.$.name, [minLength(2)]);
validate(model.$.bio, [maxLength(500)]);
// minLength → { code: 'minLength', params: { minLength: 2, actualLength: 1 } }
// maxLength → { code: 'maxLength', params: { maxLength: 500, actualLength: 501 } }

// У массива (мультивыбор, список строк) длина — в элементах, и код свой:
validate(model.$.skills, [maxLength(3)]);
// maxLength → { code: 'maxItems', params: { maxLength: 3, actualLength: 4 } } — «Не больше 3 элементов»
Непустой массив

Требование «хотя бы один элемент» — это minLength(1) на поле-массиве: validate(model.$.tags, [minLength(1, { code: 'tags.minLength' })]).

Числа​

Все числовые фабрики пропускают null/undefined; кроме isNumber, они также пропускают не-числа и NaN — строгую проверку типа даёт isNumber().

min(n, options?) · max(n, options?)​

Границы значения (включительно).

import { min, max } from '@reformer/core/validators';

validate(model.$.age, [min(18)]);
validate(model.$.discount, [max(50)]);
// min → { code: 'min', params: { min: 18, actual: 16 } }
// max → { code: 'max', params: { max: 50, actual: 75 } }

isNumber(options?)​

Значение — конечное число (не строка, не NaN).

import { required, isNumber } from '@reformer/core/validators';

validate(model.$.amount, [required(), isNumber()]);
// Ошибка: { code: 'isNumber' }

integer(options?)​

Число должно быть целым.

import { integer } from '@reformer/core/validators';

validate(model.$.count, [integer()]);
// Ошибка: { code: 'integer' }

multipleOf(n, options?)​

Число кратно делителю (сравнение с допуском — безопасно для дробного шага).

import { multipleOf } from '@reformer/core/validators';

validate(model.$.rating, [multipleOf(0.5)]);
// Ошибка: { code: 'multipleOf', params: { multipleOf: 0.5 } }

nonNegative(options?) · nonZero(options?)​

nonNegative — число ≥ 0; nonZero — число не равно нулю.

import { nonNegative, nonZero } from '@reformer/core/validators';

validate(model.$.balance, [nonNegative()]);
validate(model.$.divisor, [nonZero()]);
// nonNegative → { code: 'nonNegative' }
// nonZero     → { code: 'nonZero' }
Собирайте числовые проверки из фабрик

Единой фабрики number() больше нет. Составьте нужный набор в одном validate(...):

import { isNumber, integer, min, max } from '@reformer/core/validators';

validate(model.$.percent, [isNumber(), integer(), min(0), max(100)]);

Даты​

Принимают Date или строку, парсимую в дату. Сравнение — по нормализованным датам (время обнуляется). Пустые и невалидные даты пропускаются (используйте required() и isDate()).

isDate(options?)​

Значение — валидная дата.

import { required, isDate } from '@reformer/core/validators';

validate(model.$.eventDate, [required(), isDate()]);
// Ошибка: { code: 'date_invalid' }

minDate(date, options?) · maxDate(date, options?)​

Границы даты (включительно).

import { minDate, maxDate } from '@reformer/core/validators';

validate(model.$.startDate, [minDate(new Date())]);
validate(model.$.birthDate, [maxDate(new Date())]);
// minDate → { code: 'date_min', params: { minDate } }
// maxDate → { code: 'date_max', params: { maxDate } }

pastDate(options?) · futureDate(options?)​

pastDate — дата не в будущем; futureDate — дата не в прошлом (относительно сегодняшнего дня).

import { pastDate, futureDate } from '@reformer/core/validators';

validate(model.$.birthDate, [pastDate()]);
validate(model.$.appointment, [futureDate()]);
// pastDate   → { code: 'date_future' } (дата оказалась в будущем)
// futureDate → { code: 'date_past' }   (дата оказалась в прошлом)

minAge(years, options?) · maxAge(years, options?)​

Возраст по дате рождения (в полных годах).

import { required, minAge, maxAge } from '@reformer/core/validators';

validate(model.$.birthDate, [required(), minAge(18), maxAge(100)]);
// minAge → { code: 'date_min_age', params: { minAge: 18, currentAge } }
// maxAge → { code: 'date_max_age', params: { maxAge: 100, currentAge } }

Файлы​

Работают с одиночным файлом или массивом (File либо файлоподобный дескриптор с name / size / type). Пустые значения пропускаются — обязательность проверяет required(). Размеры — в байтах; в тексте замечания они выводятся строкой с единицей («5 МБ»).

maxFileSize(bytes, options?) · minFileSize(bytes, options?)​

Размер каждого файла; в замечание попадает первый нарушивший.

import { maxFileSize } from '@reformer/core/validators';

validate(model.$.documents, [maxFileSize(5 * 1024 * 1024)]);
// Ошибка: { code: 'maxFileSize', params: { maxFileSize, fileName, actualSize } }

maxTotalFileSize(bytes, options?)​

Суммарный размер всех файлов.

import { maxTotalFileSize } from '@reformer/core/validators';

validate(model.$.documents, [maxTotalFileSize(20 * 1024 * 1024)]);
// Ошибка: { code: 'maxTotalFileSize', params: { maxTotalFileSize, actualTotal } }

fileType(accept, options?)​

Тип файла по строке в синтаксисе атрибута <input type="file" accept>: расширения (.pdf), MIME (image/png), категории (image/*), список через запятую. Нативный accept — только подсказка диалогу выбора, на drag-and-drop он не действует; правило проверяет всё.

import { fileType } from '@reformer/core/validators';

validate(model.$.documents, [fileType('image/*,.pdf')]);
// Ошибка: { code: 'fileType', params: { accept, fileName } }

minFiles(n, options?) · maxFiles(n, options?)​

Количество файлов.

import { required, minFiles, maxFiles } from '@reformer/core/validators';

validate(model.$.documents, [required(), minFiles(1), maxFiles(5)]);
// minFiles → { code: 'minFiles', params: { minFiles: 1, actualCount } }
// maxFiles → { code: 'maxFiles', params: { maxFiles: 5, actualCount } }

Комбинирование​

К одному полю можно применить несколько правил в одном массиве validate(...) — выполняются все, замечания собираются в массив. Если два правила одного вида проверяют разное, дайте им свои коды — тогда и тексты будут разными:

import { required, minLength, pattern } from '@reformer/core/validators';

validate(model.$.password, [
  required(),
  minLength(8),
  pattern(/[A-Z]/, { code: 'password.uppercase' }),
  pattern(/[0-9]/, { code: 'password.digit' }),
]);

Справочник​

КатегорияФабрикаКод ошибкиparams
Общиеrequired()required—
Общиеpattern(regex)pattern{ pattern }
Общиеemail()email—
Общиеurl()url / url_protocol{ allowedProtocols }
Общиеphone()phone{ format }
ДлинаminLength(n)minLength; у массива — minItems{ minLength, actualLength }
ДлинаmaxLength(n)maxLength; у массива — maxItems{ maxLength, actualLength }
Числаmin(n)min{ min, actual }
Числаmax(n)max{ max, actual }
ЧислаisNumber()isNumber—
Числаinteger()integer—
ЧислаmultipleOf(n)multipleOf{ multipleOf }
ЧислаnonNegative()nonNegative—
ЧислаnonZero()nonZero—
ДатыisDate()date_invalid—
ДатыminDate(d)date_min{ minDate }
ДатыmaxDate(d)date_max{ maxDate }
ДатыpastDate()date_future—
ДатыfutureDate()date_past—
ДатыminAge(n)date_min_age{ minAge, currentAge }
ДатыmaxAge(n)date_max_age{ maxAge, currentAge }
ФайлыmaxFileSize(b)maxFileSize{ maxFileSize, fileName, actualSize }
ФайлыminFileSize(b)minFileSize{ minFileSize, fileName, actualSize }
ФайлыmaxTotalFileSize(b)maxTotalFileSize{ maxTotalFileSize, actualTotal }
ФайлыfileType(accept)fileType{ accept, fileName }
ФайлыminFiles(n)minFiles{ minFiles, actualCount }
ФайлыmaxFiles(n)maxFiles{ maxFiles, actualCount }

Дальше​