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

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

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.')]);

The following APIs can be combined with multipleOf.

Schemas

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of dailydotdev
  • GitHub profile picture of ivan-mihalic
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper