minValue

Creates a min value validation action.

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

Generics

Parameters

  • requirement TRequirement
  • message TMessage

Explanation

With minValue you can validate the value of a string, number, boolean or date. If the input does not match the requirement, you can use message to customize the error message.

Returns

Examples

The following examples show how minValue can be used.

Number schema

Schema to validate a number with a minimum value.

const NumberSchema = v.pipe(
  v.number(),
  v.minValue(100, 'The number must be at least 100.')
);

Date schema

Schema to validate a date with a minimum year.

const DateSchema = v.pipe(
  v.date(),
  v.minValue(new Date('2000-01-01'), 'The date must be after the year 1999.')
);

The following APIs can be combined with minValue.

Schemas

Methods

Utils

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of Thanaen
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of fabulousgk
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of andrew-d-jackson
  • GitHub profile picture of dslatkin