multipleOf

Creates a pipeline validation action that validates whether a number is a multiple.

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

Generics

• TInput extends number
• TRequirement extends number

Parameters

• requirement TRequirement
• message ErrorMessage | undefined

Explanation

With multipleOf you can validate the value of a number. If the input does not match the requirement, you can use message to customize the error message.

Returns

• Validation MultipleOfValidation<TInput>

Examples

The following examples show how multipleOf can be used.

Even number schema

Schema to validate an even number.

const EvenNumberSchema = number([multipleOf(2, 'The number must be even.')]);

Related

The following APIs can be combined with multipleOf.

Schemas

• any,
• number,
• special,
• unknown