toMaxValue

Creates a to max value transformation action.

const Action = v.toMaxValue<TInput, TRequirement>(requirement);

Generics

  • TInput extends ValueInput
  • TRequirement extends TInput

Parameters

  • requirement TRequirement

Explanation

With toMaxValue you can enforce a maximum value for a number, date or string. If the input does not meet the requirement, it will be changed to its value.

Returns

Examples

The following examples show how toMaxValue can be used.

Number schema

Schema to enforce a maximum value for a number.

const NumberSchema = v.pipe(v.number(), v.toMaxValue(100));

Date schema

Schema to enforce a maximum value for a date.

const DateSchema = v.pipe(v.date(), v.toMaxValue(new Date('1999-12-31')));

The following APIs can be combined with toMaxValue.

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 dailydotdev
  • GitHub profile picture of Thanaen
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of seahindeniz