BigDecimal.mod

Returns the modulo of two BigDecimal values.

You can also use the % operator on BigDecimal values.

Syntax

BigDecimal.mod(a, b, rounding?)

Parameters

• a

  The dividend BigDecimal.

• b

  The divisor BigDecimal.

• rounding optional

  If present, the rounding object must contain the following properties:

  • roundingMode

    A string specifying the rounding mode: "floor", "ceiling", "down", "up", "half-even", "half-up".

  • maximumSignificantDigits optional

    The number of significant digits (must be >= 1).

  • maximumFractionDigits optional

    The number of digits after the decimal point (must be >= 0).

  Either maximumSignificantDigits or maximumFractionDigits must be present.

Return value

A new BigDecimal.

Throws a RangeError exception in case of division by zero.

Examples

10m % 4m

2

BigDecimal.mod(10m, 4m)

2

BigDecimal.mod(10m, -4m)

2

BigDecimal.mod(-10m, 4m)

-2

BigDecimal.mod(10.2m, 3.7m, { roundingMode: "half-up", maximumFractionDigits: 0 })

3

BigDecimal.mod(10m, 0m)

RangeError: division by zero