Was this page helpful?
BigDecimal¶
types~BigDecimal(unscaledValue, scale)
The BigDecimal class provides operations for
arithmetic, scale manipulation, rounding, comparison and
format conversion. The #toString method provides a
canonical representation of a BigDecimal.
Constructor¶
new BigDecimal(unscaledValue, scale)
Constructs an immutable arbitrary-precision signed decimal number.
A BigDecimal consists of an arbitrary precision integer
unscaled value and a 32-bit integer scale. If zero
or positive, the scale is the number of digits to the right of the
decimal point. If negative, the unscaled value of the number is
multiplied by ten to the power of the negation of the scale. The
value of the number represented by the BigDecimal is
therefore (unscaledValue x 10^(-scale)).
Parameters:
| Name | Type | Description |
|---|---|---|
unscaledValue |
The integer part of the decimal. |
|
scale |
The scale of the decimal. |
Methods¶
add(other)
Returns the sum of this and the given BigDecimal.
Parameters:
| Name | Type | Description |
|---|---|---|
other |
The BigDecimal to sum to this. |
Returns:
The BigDecimal result.
compare(other)
Compares this BigDecimal with the given one.
Parameters:
| Name | Type | Description |
|---|---|---|
other |
Integer to compare against. |
Returns:
0 if they are the same, 1 if the this is greater, and -1 if the given one is greater.
equals()
Returns true if the value of the BigDecimal instance and other are the same
greaterThan()
Returns true if the current instance is greater than the other
isNegative()
Whether this value is negative.
isZero()
Whether this value is zero.
subtract(other)
Returns the difference of this and the given BigDecimal.
Parameters:
| Name | Type | Description |
|---|---|---|
other |
The BigDecimal to subtract from this. |
Returns:
The BigDecimal result.
toJSON()
Returns the string representation. Method used by the native JSON.stringify() to serialize this instance.
toNumber()
Returns a Number representation of this BigDecimal.
toString()
Returns the string representation of this BigDecimal
(static) fromBuffer()
Returns the BigDecimal representation of a buffer composed of the scale (int32BE) and the unsigned value (varint BE)
(static) fromNumber()
Returns a BigDecimal representation of the Number
(static) fromString()
Returns a BigDecimal representation of the string
(static) toBuffer()
Returns a buffer representation composed of the scale as a BE int 32 and the unsigned value as a BE varint