▸ modulo(x?: NumberLike, y?: NumberLike): number

Gets the modulo of dividing two given NumberLikes.

remarks

In most languages, ‘%’ is a remainder operator, but in some (e.g. Python, Perl) it is a modulo operator. For positive values, the two are equivalent, but when the dividend and divisor are of different signs, they give different results.

see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Remainder

Parameters:

Name	Type	Default value	Description
x	NumberLike	1	The dividend.
y	NumberLike	1	The divisor.

Returns: number

number - The resulting modulo.

Defined in: safe/math/modulo.ts:17