node-debt-snowball v2.3.4

node-debt-snowball

Node script to calculate debt repayment using the snowball method

Features

• Fully tested with 100% code coverage
• Module and CommonJS compatible
• Nightly builds to evaluate accuracy
• Lightweight - completely dependency free

Installation

npm install node-debt-snowball

Usage

Basic Usage

import snowball from 'node-debt-snowball';

const accounts = [
  {
    name: 'Credit Card',
    interest: 14.99,
    balance: 1000,
    minPayment: 75,
  },
  {
    name: 'Student Loan',
    interest: 4.75,
    balance: 7500,
    minPayment: 150,
  },
];
const additionalPayment = 100;

const repaymentPlan = snowball(accounts, additionalPayment);
console.log('repaymentPlan', repaymentPlan);

API

Full API documentation is available can be found at https://nielse63.github.io/node-debt-snowball

Response Schema

[
  {
    "balance": "number",
    "accounts": [
      {
        "name": "string",
        "balanceStart": "number",
        "balanceEnd": "number",
        "accruedInterest": "number",
        "additionalPayment": "number",
        "paymentAmount": "number"
      }
      // more accounts...
    ]
  }
  // more payment periods...
]

A full sample response can be found at examples/response.json.

Contributing

Clone the repo and install the dependencies:

git clone https://github.com/nielse63/node-debt-snowball.git
cd node-debt-snowball
npm ci

Prerequisites

Node v16.20.1:

nvm use v16.20.1

NPM Scripts