BigDecimal.mul

Returns the product of two BigDecimal values.

You can also use the * operator on BigDecimal values.

Syntax

BigDecimal.mul(a, b, rounding?)

Parameters

• a

  The multiplier BigDecimal.

• b

  The multiplicand 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.

Examples

10.3m * 4.7m

48.41

BigDecimal.mul(10.3m, 4.7m)

48.41

BigDecimal.mul(10.3m, 4.7m, { roundingMode: "half-up", maximumFractionDigits: 1 })

48.4