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

required()

function required<TForm, TField>(fieldPath, options?): void;

Defined in: core/validation/validators/required.ts:51

Валидатор обязательного поля

Проверяет, что поле имеет непустое значение. Пустыми считаются: null, undefined, '' (пустая строка). Для boolean полей требуется значение true.

Type Parameters

TForm

TForm

TField

TField

Parameters

fieldPath

Путь к полю для валидации

FieldPathNode<TForm, TField, unknown> | undefined

options?

ValidateOptions

Опции валидации (message, params)

Returns

void

Examples

// Базовое использование
validationSchema: (path, { validate }) => [
required(path.name),
required(path.email),
]

// С кастомным сообщением
required(path.phone, { message: 'Укажите номер телефона' })

// Для checkbox (требует true)
required(path.agreeToTerms, { message: 'Необходимо принять условия' })
// Ошибка валидации
{
code: 'required',
message: 'Поле обязательно для заполнения',
params: {}
}