lib-base.decimal

Home > @mosaic/lib-base > Decimal

Decimal class

Fixed-point decimal bignumber with 18 digits of precision.

Signature:

export declare class Decimal 

Remarks

Used by Mosaic libraries to precisely represent native currency (e.g. Ether), MoUSD and MSIC amounts, as well as derived metrics like collateral ratios.

Properties

Property	Modifiers	Type	Description
finite		this | undefined
HALF	static	Decimal
infinite		this | undefined
INFINITY	static	Decimal
isZero		boolean
nonZero		this | undefined
ONE	static	Decimal
zero		this | undefined
ZERO	static	Decimal

Methods

Method	Modifiers	Description
add(addend)
div(divider)
eq(that)
from(decimalish)	static
fromBigNumberString(bigNumberString)	static
gt(that)
gte(that)
lt(that)
lte(that)
max(a, b)	static
min(a, b)	static
mul(multiplier)
mulDiv(multiplier, divider)
pow(exponent)
prettify(precision)
shorten()
sub(subtrahend)
toString(precision)