minLength

Создает действие для проверки минимальной длины.

const Action = v.minLength<TInput, TRequirement, TMessage>(
  requirement,
  message
);

Обобщения

• TInput extends LengthInput
• TRequirement extends number
• TMessage extends ErrorMessage<MinLengthIssue<TInput, TRequirement>> | undefined

Параметры

• requirement TRequirement
• message TMessage

Пояснение

С помощью minLength можно проверить длину строки или массива. Для строк длина измеряется так же, как у value.length в JavaScript, то есть в единицах кода UTF-16. Для массивов длина определяется количеством элементов. Если входные данные не соответствуют requirement, можно использовать message, чтобы настроить сообщение об ошибке.

Если нужно проверить минимальное количество символов, воспринимаемых пользователем, используйте вместо этого minGraphemes. Если нужно считать каждую кодовую точку Unicode одним символом (дополнительная кодовая точка занимает в JavaScript две единицы кода UTF-16), используйте вместо этого minCodePoints.

Возвращает

• Action MinLengthAction<TInput, TRequirement, TMessage>

Примеры

В следующих примерах показано, как можно использовать minLength.

Минимальная длина строки

Схема для проверки строки минимальной длины в 3 единицы кода UTF-16.

const MinStringSchema = v.pipe(
  v.string(),
  v.minLength(3, 'The string must be 3 or more UTF-16 code units long.')
);

Минимальная длина массива

Схема для проверки массива с минимальным количеством элементов — 5.

const MinArraySchema = v.pipe(
  v.array(v.number()),
  v.minLength(5, 'The array must contain 5 numbers or more.')
);

Связанные API

Следующие API можно использовать вместе с minLength.

Схемы

any, array, custom, instance, string, tuple, unknown

Методы

pipe

Действия

minCodePoints, minGraphemes

Утилиты

isOfKind, isOfType