npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

amortize

v1.1.0

Published

Calculate the interest paid, principal paid, remaining balance, and monthly payment of a loan.

Downloads

8,869

Readme

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.