Module interest

Index

Functions

Functions

applyRateSimpleMonthly

applyRateSimpleMonthly(ivalue: Money, r: Rate): Generator<AppliedInterest>
applyRateSimpleMonthly(ivalue: Money, r: Rate, paymenmt: Money): Generator<AppliedLoanPayment>

- Defined in src/interest.ts:28
Parameters
- ivalue: Money
  
  Initial value of the asset or liability
- r: Rate
  
  Annual simple rate to apply
Returns Generator<AppliedInterest>
- Defined in src/interest.ts:29
Parameters
- ivalue: Money
- r: Rate
- paymenmt: Money
Returns Generator<AppliedLoanPayment>

Const convertInterest

convertInterest(rate: Rate, fromPeriod: number | CalendarUnit, newPeriod: number | CalendarUnit): Rate

- Defined in src/interest.ts:83
Convert interest rates between different compounding periods.

Parameters
- rate: Rate
  
  The rate per year in the original compounding period.
- fromPeriod: number | CalendarUnit
  
  The number of periods per year for the original compounding period, or the corresponding CalendarUnit.
- newPeriod: number | CalendarUnit
  
  The number of periods per year for the new compounding period, or the corresponding CalendarUnit.
Returns Rate

The effective rate per year at the new compounding period.

Const convertInterestPerPeriod

convertInterestPerPeriod(rate: Rate, fromPeriod: number | CalendarUnit, newPeriod: number | CalendarUnit): Rate

- Defined in src/interest.ts:100
Convert interest rates between different compounding periods.

Parameters
- rate: Rate
  
  The rate per year in the original compounding period.
- fromPeriod: number | CalendarUnit
  
  The number of periods per year for the original compounding period, or the corresponding CalendarUnit.
- newPeriod: number | CalendarUnit
  
  The number of periods per year for the new compounding period, or the corresponding CalendarUnit.
Returns Rate

The effective rate per period at the new compounding period.

Const interestCalculator

interestCalculator(): undefined

- Defined in src/interest.ts:19
Returns undefined

Generated using TypeDoc