Class Money

Index

Properties

Methods

add compareTo equals isNegative isPositive isZero negate render subtract faceValueOf of zero

Properties

`Readonly`currency

currency: string

The currency tag.

`Readonly`minor

minor: number

The amount in integer minor units (can be negative for a delta).

Methods

add

add(other: Money): Money
This + other (same currency).
Parameters
- other: Money
Returns Money
- Defined in packages/server/src/mud/lib/banking/Money.ts:79

compareTo

compareTo(other: Money): number
−1 / 0 / +1 ordering against other (same currency).
Parameters
- other: Money
Returns number
- Defined in packages/server/src/mud/lib/banking/Money.ts:111

equals

equals(other: Money): boolean
Equal currency and amount.
Parameters
- other: Money
Returns boolean
- Defined in packages/server/src/mud/lib/banking/Money.ts:117

isNegative

isNegative(): boolean
True iff the amount is strictly negative.

Returns boolean
- Defined in packages/server/src/mud/lib/banking/Money.ts:101

isPositive

isPositive(): boolean
True iff the amount is strictly positive.

Returns boolean
- Defined in packages/server/src/mud/lib/banking/Money.ts:106

isZero

isZero(): boolean
True iff the amount is exactly zero.

Returns boolean
- Defined in packages/server/src/mud/lib/banking/Money.ts:96

negate

negate(): Money
The signed negation (a debit ↔ credit flip).

Returns Money
- Defined in packages/server/src/mud/lib/banking/Money.ts:91

render

render(): string
A human string — "12 credits" / "1 credit".

Returns string
- Defined in packages/server/src/mud/lib/banking/Money.ts:122

subtract

subtract(other: Money): Money
This − other (same currency).
Parameters
- other: Money
Returns Money
- Defined in packages/server/src/mud/lib/banking/Money.ts:85

`Static`faceValueOf

faceValueOf(denomination: string): number
The face value (minor units) of one coin of denomination.
Parameters
- denomination: string
Returns number
- Defined in packages/server/src/mud/lib/banking/Money.ts:66

`Static`of

of(minor: number, currency?: string): Money
A Money of minor integer units. Throws on a non-integer amount.
Parameters
- minor: number
- currency: string = DEFAULT_CURRENCY
Returns Money
- Defined in packages/server/src/mud/lib/banking/Money.ts:51

`Static`zero

zero(currency?: string): Money
The zero amount in currency.
Parameters
- currency: string = DEFAULT_CURRENCY
Returns Money
- Defined in packages/server/src/mud/lib/banking/Money.ts:61