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

requirement TRequirement
message ErrorMessage | undefined

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

Validation MaxValueValidation<TInput, TRequirement>

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.