notValue

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

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

Generics

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

Parameters

requirement TRequirement
message ErrorMessage | undefined

Explanation

With notValue 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 NotValueValidation<TInput, TRequirement>

Examples

The following examples show how notValue can be used.

Number schema

Schema to validate a number that is more or less than 100.

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

Date schema

Schema to validate a date that is before or after the start of 2000.

const DateSchema = date([
  notValue(new Date('2000-01-01'), 'The date must not be the start of 2000.'),
]);

The following APIs can be combined with notValue.