mortgage-helpers

A suite of JavaScript functions to compute mortgage values, such as monthly payments or maximum borrowing capacity. It can also calculate the future value of a savings capital, since those subjects are quite close. Note most functions support negative interest rates.

I couldn't find a modern JS library published on npm to do that, so here it is! It has no dependencies and supports Typescript. It may need more functions though, feel free to contribute!

Someone has made a working demo with an interface here (it's in french though but nothing hard to grasp, it's just a form using this lib).

Get started

yarn add mortgage-helpers or npm i mortgage-helpers

Usage

import mortgageHelpers from 'mortgage-helpers'

mortgageHelpers.getMonthlyPayments(10000, 1, 24) // should return 421.02

You can also directly import functions like this: import {getMonthlyPayments} from 'mortgage-helpers'

API

getMonthlyPayments:

This function will give you the fixed monthly amount to pay for a mortgage, based on its amount, interest rate and number of months. Loan amount and month duration must be positive.

getMonthlyPayments: (loanAmount: number, interestRate: number, months: number) => number

If one param is missing or is not a valid number, it will throw an error.

getMaximumBorrowingCapacity:

This function will give you the maximum amount you can borrow, based on available revenue (monthly with deduced charges), interest rate, number of months and max debt ratio (percentage between 1 and 100). Available revenue must be positive along with month duration.

getMaximumBorrowingCapacity: (
  availableRevenue: number,
  interestRate: number,
  months: number
  maximumDebtRatio: number
) => {
  loanAmount: number,
  monthlyPayment: number,
  interestsAmount: number,
};

If one param is missing or is not a valid number, it will throw an error.

getInterestRate:

This function will give you a loan's interest rate, based on loan amount (what has been borrowed without interests), months duration and monthly payments. This is kinda the reverse of getMonthlyPayments. The interest rate will be a number with a maximum of 3 decimals.

getInterestRate: (
  loanAmount: number,
  months: number
  monthlyPayments: number
) => number;

If one param is missing or is not a valid number, it will throw an error. Also please note this function may fail if computation is too hard (it mainly occurs if there are too many decimals in params) OR if interest rate is negative, which is not supported. This is indeed the only function here that does not.

getSavingsCapitalAtMaturity:

This function will give you a savings capital value at desired maturity, based on initial capital, interest rate, months duration and monthly installments. Initial capital must be equal to zero or positive and monthly payments are optional.

getSavingsCapitalAtMaturity: (
  initialCapital: number,
  yearlyInterest: number,
  months: number,
  monthlyPayments: number
) => number

If one param is missing or is not a valid number, it will throw an error.

getSavingsMonthlyObjective:

This function will give you the required monthly installments to reach objectiveCapital, based on initial capital, interests and months duration. This is kinda the reverse of getSavingsCapitalAtMaturity. Initial and objective capital must be equal to zero or positive, and objective capital must be greater than initial capital.

getSavingsMonthlyObjective: (
  initialCapital: number,
  yearlyInterest: number,
  months: number,
  objectiveCapital: number
) => number

If one param is missing or is not a valid number, it will throw an error.

Contributing

Any new mortgage-related function is welcome! Feel free to open a pull request, just make sure all tests pass (and please add new ones!).

License

MIT

agaetis-it / mortgage-helpers Goto Github PK