Class Coin`Abstract`

Abstract class representing a coin, implementing the Currency interface.

Hierarchy (view full)

Coin
- VET
- VTHO

Implements

Currency

Index

Constructors

Accessors

bi bytes code n value

Methods

compareTo isEqual toString

Constructors

`Protected`constructor

new Coin(code, value): Coin
Creates an instance of the class with the specified code and value.
Parameters
- code: Txt
  The code associated with this instance.
- value: FixedPointNumber
  The value associated with this instance.
Returns Coin
- Defined in packages/core/src/vcdm/currency/Coin.ts:28

Accessors

bi

get bi(): bigint
Returns the integer part of the FixedPointNumber value.

Returns bigint
the integer part of this FixedPointNumber value.

Throws
If the value is not finite.

Remarks
Do not use for financial math: apply FixedPointNumber methods instead.
Implementation of Currency.bi
- Defined in packages/core/src/vcdm/currency/Coin.ts:63

bytes

get bytes(): Uint8Array
Returns the array of bytes representing the Normalization Form Canonical Composition Unicode Equivalence of the textual expression 'value code'.

Returns Uint8Array
Implementation of Currency.bytes
- Defined in packages/core/src/vcdm/currency/Coin.ts:72

code

get code(): Txt
Return the code as a Txt object.

Returns Txt
The code object

Remarks
Since currency codes likely use Unicode composite symbols, Txt type enforce the representation of the code is normalized.
Implementation of Currency.code
- Defined in packages/core/src/vcdm/currency/Coin.ts:41

n

get n(): number
Return this {@linl value} approximated as number.

Returns number
Remarks
Do not use for financial math: apply FixedPointNumber methods instead.
Implementation of Currency.n
- Defined in packages/core/src/vcdm/currency/Coin.ts:81

value

get value(): FixedPointNumber
Return the current value as an FixedPointNumber (Fixed-Point Number).

Returns FixedPointNumber
The current value in Fixed-Point Number format.
Implementation of Currency.value
- Defined in packages/core/src/vcdm/currency/Coin.ts:50

Methods

compareTo

compareTo(that): number
Compares this Currency object with another Currency object for order.
Parameters
- that: Currency
  The Currency object to be compared.
Returns number
A negative integer, zero, or a positive integer as this Currency is less than, equal to, or greater than the specified Currency.

Throws
If the currency codes do not match.
Implementation of Currency.compareTo
- Defined in packages/core/src/vcdm/currency/Coin.ts:93

isEqual

isEqual(that): boolean
Determines if this Currency object is equal to another Currency object.
Parameters
- that: Currency
  The Currency object to compare with the current instance.
Returns boolean
- true if the objects are considered equal, otherwise false.
Implementation of Currency.isEqual
- Defined in packages/core/src/vcdm/currency/Coin.ts:109

toString

toString(): string
Returns the textual representation of this currency as 'value code'.

Returns string
A string that contains the value and code properties of the object.
- Defined in packages/core/src/vcdm/currency/Coin.ts:123