value

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

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

Generics

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

Parameters

requirement TRequirement
message ErrorMessage | undefined

Explanation

With value 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 ValueValidation<TInput, TRequirement>

Examples

The following examples show how value can be used.

Number schema

Schema to validate a number with a specific value.

const NumberSchema = number([value(100, 'The number must be 100.')]);

Date schema

Schema to validate a date with a specific value.

const DateSchema = date([
  value(new Date('2000-01-01'), 'The date must be the first day of 2000.'),
]);

The following APIs can be combined with value.