Class BigDecimal

Class utility to handle decimal arithmetic.

Index

Methods

div eq gt max min minus plus round times toFixed toNumber toString of

Methods

div

div(num: NumberSource): coreUtils.numbersUtils.BigDecimal
Returns a BigDecimal number whose value is the value of this BigDecimal number divided by n.

If the result has more fraction digits than is specified by Big.DP, it will be rounded to Big.DP decimal places using rounding mode Big.RM.
Parameters
- num: NumberSource
Returns coreUtils.numbersUtils.BigDecimal
Throws
NaN if n is invalid.

Throws
±Infinity on division by zero.

Throws
NaN on division of zero by zero.
- Defined in packages/common/src/utils/numbers.utils.ts:49

eq

eq(num: NumberSource): boolean
Returns true if the value of this BigDecimal is equal to the value of num.
Parameters
- num: NumberSource
Returns boolean
- Defined in packages/common/src/utils/numbers.utils.ts:125

gt

gt(num: NumberSource): boolean
Returns true if the value of this BigDecimal is greater than the value of num.
Parameters
- num: NumberSource
Returns boolean
- Defined in packages/common/src/utils/numbers.utils.ts:135

max

max(num: NumberSource): coreUtils.numbersUtils.BigDecimal
Returns a BigDecimal representing the maximum of this number and the provided number. If this number is greater than or equal to the provided number, returns this number. Otherwise, returns the provided number.
Parameters
- num: NumberSource
  The number to compare with
Returns coreUtils.numbersUtils.BigDecimal
The maximum of this number and the provided number
- Defined in packages/common/src/utils/numbers.utils.ts:150

min

min(num: NumberSource): coreUtils.numbersUtils.BigDecimal
Returns a BigDecimal representing the minimum of this number and the provided number. If this number is less than or equal to the provided number, returns this number. Otherwise, returns the provided number.
Parameters
- num: NumberSource
  The number to compare with
Returns coreUtils.numbersUtils.BigDecimal
The minimum of this number and the provided number
- Defined in packages/common/src/utils/numbers.utils.ts:170

minus

minus(num: NumberSource): coreUtils.numbersUtils.BigDecimal
Returns a BigDecimal number whose value is the value of this number minus n.
Parameters
- num: NumberSource
Returns coreUtils.numbersUtils.BigDecimal
Throws
NaN if n is invalid.
- Defined in packages/common/src/utils/numbers.utils.ts:61

plus

plus(num: NumberSource): coreUtils.numbersUtils.BigDecimal
Returns a BigDecimal whose value is the value of this number plus n.
Parameters
- num: NumberSource
Returns coreUtils.numbersUtils.BigDecimal
Throws
NaN if n is invalid.
- Defined in packages/common/src/utils/numbers.utils.ts:73

round

round(dp?: number, rm?: RoundingMode): coreUtils.numbersUtils.BigDecimal
Returns a BigDecimal whose value is the value of this BigDecimal rounded
Parameters
- Optionaldp: number
  Decimal places, 0 to 1e+6 inclusive
- Optionalrm: RoundingMode
  Rounding mode: ROUND_DOWN, ROUND_HALF_UP, ROUND_HALF_EVEN or ROUND_UP.
Returns coreUtils.numbersUtils.BigDecimal
- Defined in packages/common/src/utils/numbers.utils.ts:118

times

times(num: NumberSource): coreUtils.numbersUtils.BigDecimal
Returns a BigDecimal number whose value is the value of this BigDecimal number times n.
Parameters
- num: NumberSource
Returns coreUtils.numbersUtils.BigDecimal
Throws
NaN if n is invalid.
- Defined in packages/common/src/utils/numbers.utils.ts:85

toFixed

toFixed(dp?: number): string
Returns a string representing the value of this Trova number in normal notation to a fixed number of dp decimal places.
Parameters
- Optionaldp: number
Returns string
- Defined in packages/common/src/utils/numbers.utils.ts:95

toNumber

toNumber(): number
Returns a primitive number representing the value of this Trova number.

Returns number
- Defined in packages/common/src/utils/numbers.utils.ts:102

toString

toString(): string
Returns a string representing the value of this Trova number.

Returns string
- Defined in packages/common/src/utils/numbers.utils.ts:109

`Static`of

of(initialValue: NumberSource): coreUtils.numbersUtils.BigDecimal
Returns a new BigDecimal number instance for the given NumberSource.
Parameters
- initialValue: NumberSource
Returns coreUtils.numbersUtils.BigDecimal
Throws
NaN on an invalid value.
- Defined in packages/common/src/utils/numbers.utils.ts:36

Class BigDecimal

Index

Methods

Methods

div

Parameters

Returns coreUtils.numbersUtils.BigDecimal

Throws

Throws

Throws

eq

Parameters

Returns boolean

gt

Parameters

Returns boolean

max

Parameters

Returns coreUtils.numbersUtils.BigDecimal

min

Parameters

Returns coreUtils.numbersUtils.BigDecimal

minus

Parameters

Returns coreUtils.numbersUtils.BigDecimal

Throws

plus

Parameters

Returns coreUtils.numbersUtils.BigDecimal

Throws

round

Parameters

Returns coreUtils.numbersUtils.BigDecimal

times

Parameters

Returns coreUtils.numbersUtils.BigDecimal

Throws

toFixed

Parameters

Returns string

toNumber

Returns number

toString

Returns string

Staticof

Parameters

Returns coreUtils.numbersUtils.BigDecimal

Throws

Settings

On This Page

`Static`of