maxValue

Creates a pipeline validation action that validates the value of a string, number, boolean or date.

const Validation = maxValue<TInput, TRequirement>(requirement, message);

Generics

  • TInput extends string | number | bigint | boolean | Date
  • TRequirement extends TInput

Parameters

Explanation

With maxValue 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 maxValue can be used.

Number schema

Schema to validate a number with a maximum value.

const NumberSchema = number([maxValue(100, 'The number must not exceed 100.')]);

Date schema

Schema to validate a date with a maximum year.

const DateSchema = date([
  maxValue(new Date('1999-12-31'), 'The date must not exceed the year 1999.'),
]);

The following APIs can be combined with maxValue.

Schemas

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 dailydotdev
  • GitHub profile picture of ivan-mihalic
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper