amortization
A simple module to calculate the amortization schedule of a loan.Install
npm install amortization --saveAPI Documentation
Functions
- amortizationSchedule(principal, yearsDuration, yearlyRate) ⇒
Array.<MonthlyPayment>
Generates an amortization schedule.
- yearlyAmortizationSchedule(principal, yearsDuration, yearlyRate) ⇒
Array.<YearlyPayment>
Generates a yearly amortization schedule with the pricipal, interest, and payment of each year of the loan.
Typedefs
- MonthlyPayment :
Object
- YearlyPayment :
Object
amortizationSchedule(principal, yearsDuration, yearlyRate) ⇒ Array.<MonthlyPayment>
Generates an amortization schedule.Kind: global function
Returns:
Array.<MonthlyPayment>
- - Each item in the array is a monthly loan payment object| Param | Type | Description | | --- | --- | --- | | principal |
number
| The opening principal of the loan |
| yearsDuration | number
| The number of years for the load |
| yearlyRate | number
| The yearly rate for the loan |yearlyAmortizationSchedule(principal, yearsDuration, yearlyRate) ⇒ Array.<YearlyPayment>
Generates a yearly amortization schedule with the pricipal, interest, and payment of each year of the loan.Kind: global function
Returns:
Array.<YearlyPayment>
- - Each item in the array is a payment object| Param | Type | Description | | --- | --- | --- | | principal |
number
| The opening principal of the loan |
| yearsDuration | number
| The number of years for the load |
| yearlyRate | number
| The yearly rate for the loan |MonthlyPayment : Object
Kind: global typedefProperties
| Name | Type | Description | | --- | --- | --- | | paymentNumber |
number
| number of payment in the schedule |
| payment | number
| total amount of monthly loan paid |
| interestPayment | number
| amount of monthly interest payment |
| interestPaymentRounded | number
| rounded version of interestPayment |
| principalPayment | number
| amount of monthly principal payment |
| principalPaymentRounded | number
| rounded version of principalPayment |
| principalBalance | number
| balance of loan principal after payment |
| principalBalanceRounded | number
| rounded version of principalBalance |
| accInterest | number
| total interest paid so to date |
| accInterestRounded | number
| rounded version of accInterest |YearlyPayment : Object
Kind: global typedefProperties
| Name | Type | Description | | --- | --- | --- | | paymentNumber |
number
| number of payment in the yearly schedule |
| payment | number
| total amount of yearly loan payment |
| paymentRounded | number
| rounded version of payment |
| interestPayment | number
| amount of yearly interest payment |
| interestPaymentRounded | number
| rounded version of interestPayment |
| principalPayment | number
| amount of yearly principal payment |
| principalPaymentRounded | number
| rounded version of principalPayment |