toMaxValue

Creates a to max value transformation action.

const Action = v.toMaxValue<TInput, TRequirement>(requirement);

Generics

• TInput extends ValueInput
• TRequirement extends TInput

Parameters

• requirement TRequirement

Explanation

With toMaxValue you can enforce a maximum value for a number, date or string. If the input does not meet the requirement, it will be changed to its value.

Returns

• Action ToMaxValueAction<TInput, TRequirement>

Examples

The following examples show how toMaxValue can be used.

Number schema

Schema to enforce a maximum value for a number.

const NumberSchema = v.pipe(v.number(), v.toMaxValue(100));

Date schema

Schema to enforce a maximum value for a date.

const DateSchema = v.pipe(v.date(), v.toMaxValue(new Date('1999-12-31')));

Related

The following APIs can be combined with toMaxValue.

Schemas

• any,
• bigint,
• boolean,
• date,
• number,
• special,
• string,
• unknown

Methods

• pipe

Utils

• isOfKind,
• isOfType