Class RetirementCalculator

RetirementCalculator provides various methods to calculate retirement finances, including inflation adjustments, balance after inflation, and compound interest calculations.

Hierarchy

  • RetirementCalculator

Constructors

constructor

Methods

formatNumberWithCommas adjustDesiredBalanceDueToInflation getValueAfterInflation getDesiredBalanceByYearlySpend getYearlyWithdrawalAmountByBalance getInterestOverTime getAdditionalContributionsTotalInterestMultiplier getTotalPeriods getInterestRatePerPeriod getHowOftenToCompound getCompoundMultiplier convertBalanceBasedOnFrequency getContributionNeededForDesiredBalance getCompoundInterestWithAdditionalContributions aggregateDataByYear

Constructors

constructor

Methods

formatNumberWithCommas

  • Formats a number with commas and limits it to two decimal places.

    Parameters

    • value: number

      The number to be formatted.

    Returns string

    A string representation of the number with formatted commas.

adjustDesiredBalanceDueToInflation

  • Adjust how much a balance would be with inflation added.

    Parameters

    • desiredBalance: number
    • years: number
    • inflationRate: number

    Returns number

Private getValueAfterInflation

  • Private

    Calculate the value of something subtracting inflation over a period of time.

    Parameters

    • balance: number
    • inflationRate: number
    • years: number

    Returns number

getDesiredBalanceByYearlySpend

  • Calculate how much would need to be in retirement in order to spend $yearlySpend a year

    Parameters

    • yearlySpend: number
    • yearlyWithdrawalRate: number = 0.04

    Returns number

getYearlyWithdrawalAmountByBalance

  • Calculate how much could be spent in retirement based on an x% rule.

    Parameters

    • balance: number
    • yearlyWithdrawalRate: number

    Returns number

Private getInterestOverTime

  • Private

    Calculate the interest of a balance over a given period of time.

    Parameters

    • startingBalance: number
    • interestRate: number
    • periods: number

    Returns number

Private getAdditionalContributionsTotalInterestMultiplier

  • Private

    Calculate the total interest multiplier used for determining contributions needed to hit a goal.

    Parameters

    • interestRate: number
    • periods: number

    Returns number

Private getTotalPeriods

  • Private

    Calculate the total number of periods based on years and periods per year.

    Parameters

    • years: number
    • periodsPerYear: number

    Returns number

Private getInterestRatePerPeriod

  • Private

    Calculate the interest rate per period based on the frequency of compounding.

    Parameters

    • interestRate: number
    • compoundingFrequency: number

    Returns number

Private getHowOftenToCompound

  • Private

    Calculate how often compounding should occur based on contribution and compounding frequencies.

    Parameters

    • contributionFrequency: number
    • compoundingFrequency: number

    Returns number

Private getCompoundMultiplier

  • Private

    Calculate the compound multiplier based on contribution and compounding frequencies. ex. If we contribute yearly, but compound monthly, then our compound multiplier would be 12.

    Parameters

    • contributionFrequency: number
    • compoundingFrequency: number

    Returns number

Private convertBalanceBasedOnFrequency

  • Private

    Convert the balance to match contribution and compounding being the same.

    Parameters

    • balance: number
    • contributionFrequency: number
    • compoundingFrequency: number

    Returns number

getContributionNeededForDesiredBalance

  • Determine the contribution needed at what frequency to reach a desired balance.

    Parameters

    • startingBalance: number
    • desiredBalance: number
    • years: number
    • interestRate: number
    • contributionFrequency: number
    • compoundingFrequency: number
    • inflationRate: number = 0.02

    Returns DetermineContributionType

getCompoundInterestWithAdditionalContributions

  • Calculate compound interest with additional contributions made over a given period of time.

    Parameters

    • initialBalance: number

      The initial balance.

    • additionalContributionAmount: number

      The additional contribution amount.

    • years: number

      The number of years.

    • interestRate: number

      The interest rate.

    • contributionFrequency: number

      The contribution frequency.

    • compoundingFrequency: number

      The compounding frequency.

    Returns CompoundingInterestObjectType

    An object that contains the results, and a history.

aggregateDataByYear

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc