Note: There is a newer version (0.2.0) of this package available. Click here to view docs for the latest version.
Module money
lakshansivagnanasothy/money
0.1.0
Functions
areEqual
Isolated Function
Returns true if values firstValue and secondValue are the equal, including the currency.
Return Type
- boolean - currency equal status
areSameCurrency
Isolated Function
Returns true if values firstValue and r have a currency code and they are the same values.
Return Type
- boolean - currency type equal status
isNegative
Isolated Function
Returns true if the specified money value is valid and is negative.
Parameters
- money Money - object to the validated
Return Type
- boolean - negative status
isPositive
Isolated Function
Returns true if the specified money value is valid and is positive.
Parameters
- money Money - object to the validated
Return Type
- boolean - positive status
isValid
Isolated Function
Checks if specified value has a valid units/nanos signs and ranges.
Parameters
- money Money - object to be validated
Return Type
- boolean - Validity
isZero
Isolated Function
Checks if the money is zero.
Parameters
- money Money - object to be validated
Return Type
- boolean - zero status
multiplySlow
Isolated Function
Slow multiplication operation done through adding the value to itself n-1 times.
Return Type
- Money - multiplied money object
negate
Isolated Function
Negate returns the same amount with the sign negated.
Parameters
- money Money - object to be negated
Return Type
- Money - negated money object
renderMoney
Isolated Function
Used to render Money in a readable format.
Parameters
- money Money -
Moneyvalue to be rendered
Return Type
- string - rendered value as a string
signMatches
Isolated Function
Checks if the sign matches.
Parameters
- money Money - object to be validated
Return Type
- boolean - validity status
sum
Isolated Function
Adds two Money values.
Return Type
- Money - sum money object
validNanos
Isolated Function
Checks if nanos are valid.
Parameters
- nanos int - nano input
Return Type
- boolean - validity status