Git Product home page Git Product logo

amortize's Introduction

amortize

Build Status codecov

A node module to calculate the interest paid, principal paid, remaining balance, and monthly payment of a loan.

What is loan amortization?

From Ask CFPB:

Amortization describes the process of gradual payment of the amount on your loan. For each of your monthly payments, a portion is applied towards the amount of the loan – the principal – and a portion of the payment is applied towards paying the finance charge – the interest.

A greater percentage of your monthly payment is applied to interest early in the life of the loan, and a greater percentage is applied to the principal at the end. Thus, the principal balance decreases slowly at first and more quickly closer to the end of the loan term. So if you default early in the life of the loan, you will still owe a significant amount on the principal because only a relatively small percentage of your monthly payments were applied to the principal.

Installation

First install node.js. Then:

npm install amortize --save

Usage

Require the module and pass the amount of the loan, annual rate, the length of loan in months, and the length of time in months over which you would like to do the amortization calculation. For example for a loan amount of $180,000, an interest rate of 4.25%, a total term of 360 months (30 years) you could calculate the amortization over 60 months (5 years) with the following:

var amortize = require('amortize');

amortize({
  amount: 180000,
  rate: 4.25,
  totalTerm: 360,
  amortizeTerm: 60
});

This will return an object containing the interest, principal, balance, and monthly payment as both raw and rounded values:

{
  interest: 36583.362108097754,  // the interest paid in the amortization period
  principal: 16546.146128485594, // the principal paid in the amortization period
  balance: 163453.85387151438, // the balance left after the amortization period
  payment: 885.4918039430557, // the monthly payments that would be made
  interestRound: '36583.36',
  principalRound: '16546.15',
  balanceRound: '163453.85',
  paymentRound: '885.49'
}

This module also supports straightline amortization schedules with equal principal payments:

amortize({
  amount: 180000,
  rate: 4.25,
  totalTerm: 360,
  amortizeTerm: 60,
  repaymentType: 'equal-principal-payment',
  partialMonthOffset: 0.5 // optional month offset
});

Contributing

Please read the Contributing guidelines.

Running Tests

We are using nodeunit to test. To run tests, first install nodeunit and any dependencies via npm:

npm install

Run tests with:

npm test

Notes

This module is intended for predictive purposes and assumes that the borrower does not pay more than the calculated payment each month.

amortize's People

Contributors

ascott1 avatar avantassel avatar contolini avatar scotchester avatar sethreidnz avatar yonatann avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.