gtValue

Creates a greater than value validation action.

const Action = v.gtValue<TInput, TRequirement, TMessage>(requirement, message);

Generics

• TInput extends ValueInput
• TRequirement extends TInput
• TMessage extends ErrorMessage<GtValueIssue<TInput, TRequirement>> | undefined

Parameters

• requirement TRequirement
• message TMessage

Explanation

With gtValue 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

• Action GtValueAction<TInput, TRequirement, TMessage>

Examples

The following examples show how gtValue can be used.

Number schema

Schema to validate a number with a greater than value.

const NumberSchema = v.pipe(
  v.number(),
  v.gtValue(100, 'The number must be greater than 100.')
);

Date schema

Schema to validate a date with a greater than year.

const DateSchema = v.pipe(
  v.date(),
  v.gtValue(
    new Date('2000-01-01'),
    'The date must be greater than 1st January 2000.'
  )
);

Related

The following APIs can be combined with gtValue.

Schemas

any, bigint, boolean, custom, date, number, string, unknown

Methods

pipe

Utils

isOfKind, isOfType