minValue

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

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

Generics

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

Parameters

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 = number([
  minValue(100, 'The number must be at least 100.'),
]);

Date schema

Schema to validate a date with a minimum year.

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

The following APIs can be combined with minValue.

Schemas