Retirement Calculator

A TypeScript library for retirement financial calculations.

Installation

npm i retirement-calculator
Copy

What it does

• Calculate contributions needed to reach a target balance
• Project compound interest with regular contributions
• Model age-based return strategies (glidepaths)
• Account for inflation impact on future balances

Quick Start

import { RetirementCalculator } from 'retirement-calculator';

const calculator = new RetirementCalculator();

// Basic compound interest with monthly contributions
const result = calculator.getCompoundInterestWithAdditionalContributions(
  10000,  // starting balance
  500,    // monthly contribution
  30,     // years
  0.08,   // 8% annual return
  12,     // contribution frequency (monthly)
  12      // compounding frequency (monthly)
);

console.log(`Final balance: $${result.balance.toFixed(2)}`);
console.log(`Total contributions: $${result.totalContributions.toFixed(2)}`);
console.log(`Interest earned: $${result.totalInterestEarned.toFixed(2)}`);
Copy

Dynamic Glidepath Calculations

Model changing investment strategies over time, like target-date funds.

const result = calculator.getCompoundInterestWithGlidepath(
  25000,  // starting balance
  1000,   // monthly contribution
  25,     // starting age
  65,     // retirement age
  {
    mode: 'fixed-return',
    startReturn: 0.10,  // 10% at age 25
    endReturn: 0.055    // 5.5% at age 65
  }
);

console.log(`Final balance: $${result.finalBalance}`);
Copy

Three glidepath modes available:

• fixed-return: Linear decline from aggressive to conservative returns
• allocation-based: Equity/bond blending like target-date funds
• custom-waypoints: User-defined age/return or age/allocation targets

Return Metrics

The calculator provides two return metrics:

• effectiveAnnualReturn: Overall account growth including contributions
• averageAnnualInterestRate: Investment performance only (compare against benchmarks)

Examples

See the examples directory for complete scenarios:

• basic-retirement-gap-analysis.ts - Goal-based planning
• lifestyle-based-retirement-planning.ts - Spending-based planning
• advanced-dynamic-investment-strategies.ts - Glidepath strategies

Run any example:

npx ts-node examples/basic-retirement-gap-analysis.ts
Copy

See it in Action

This package powers the calculators at Common Cents Academy. Try them out to see what's possible.

Documentation

• API Documentation - Full method reference (TypeDoc)
• CHANGELOG - Version history and migration guides

Limitations

• Assumes steady returns (real markets fluctuate)
• No Monte Carlo simulation yet
• No tax modeling

License

MIT