Interface IMoney<T>

Type Parameters

T extends CurrencyCode = CurrencyCode

Hierarchy

IMoney

Implemented by

Money

Index

Methods

add divide equals getAmount getCurrency greaterThan greaterThanOrEqual lessThan lessThanOrEqual multiply subtract toJSON toLocaleString

Methods

add

add(...n: AbstractMoney<T>[]): AbstractMoney<T>
Parameters
- Rest ...n: AbstractMoney<T>[]
Returns AbstractMoney<T>
- Defined in Money/index.ts:33

divide

divide(n: number): AbstractMoney<T>
Parameters
- n: number
Returns AbstractMoney<T>
- Defined in Money/index.ts:36

equals

equals(m: AbstractMoney<T>): boolean
Parameters
- m: AbstractMoney<T>
Returns boolean
- Defined in Money/index.ts:38

getAmount

getAmount(): number
Returns number
- Defined in Money/index.ts:30

getCurrency

getCurrency(): T
Returns T
- Defined in Money/index.ts:31

greaterThan

greaterThan(m: AbstractMoney<T>): boolean
Parameters
- m: AbstractMoney<T>
Returns boolean
- Defined in Money/index.ts:39

greaterThanOrEqual

greaterThanOrEqual(m: AbstractMoney<T>): boolean
Parameters
- m: AbstractMoney<T>
Returns boolean
- Defined in Money/index.ts:40

lessThan

lessThan(m: AbstractMoney<T>): boolean
Parameters
- m: AbstractMoney<T>
Returns boolean
- Defined in Money/index.ts:41

lessThanOrEqual

lessThanOrEqual(m: AbstractMoney<T>): boolean
Parameters
- m: AbstractMoney<T>
Returns boolean
- Defined in Money/index.ts:42

multiply

multiply(n: number): AbstractMoney<T>
Parameters
- n: number
Returns AbstractMoney<T>
- Defined in Money/index.ts:35

subtract

subtract(...n: AbstractMoney<T>[]): AbstractMoney<T>
Parameters
- Rest ...n: AbstractMoney<T>[]
Returns AbstractMoney<T>
- Defined in Money/index.ts:34

toJSON

toJSON(): {
amount: number;
currency: T;
}
Returns {
amount: number;
currency: T;
}
- amount: number
- currency: T
- Defined in Money/index.ts:45

toLocaleString

toLocaleString(locale?: string): string
Parameters
- Optional locale: string
Returns string
- Defined in Money/index.ts:44

Generated using TypeDoc