ltValue

Creates a less than value validation action.

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

Generics

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

Parameters

• requirement TRequirement
• message TMessage

Explanation

With ltValue 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 LtValueAction<TInput, TRequirement, TMessage>

Examples

The following examples show how ltValue can be used.

Number schema

Schema to validate a number with a less than value.

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

Date schema

Schema to validate a date with a less than value.

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

Related

The following APIs can be combined with ltValue.

Schemas

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

Methods

pipe

Utils

isOfKind, isOfType