number

Создаёт схему числа.

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

Дженерики

• TMessage extends ErrorMessage<NumberIssue> | undefined

Параметры

• message TMessage

Объяснение

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

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

• Schema NumberSchema<TMessage>

Примеры

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

Схема целого числа

Схема для валидации целого числа.

const IntegerSchema = v.pipe(v.number(), v.integer());

Ограничение минимума

Схема, требующая минимальное значение 10.

const MinNumberSchema = v.pipe(v.number(), v.toMinValue(10));

Валидация диапазона

Схема, которая валидирует число в диапазоне.

const NumberRangeSchema = v.pipe(v.number(), v.minValue(10), v.maxValue(20));

Связанные элементы

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

Схемы

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, finite, flavor, gtValue, guard, integer, ltValue, maxValue, metadata, minValue, multipleOf, notValue, notValues, rawCheck, rawTransform, readonly, safeInteger, title, toBoolean, toDate, toBigint, toMaxValue, toMinValue, toString, transform, value, values

Утилиты

entriesFromList, isOfKind, isOfType