fiscal-js

A finance calculator inspired by the HP12-c to help you with your fiscal responsibilities and goals.

Installation

npm i fiscal-js --save

or

yarn add fiscal-js

Usage

const Fiscal = require('fiscal-js');
//or
import Fiscal from "fiscal-js";

// Fiscal will use en-US and USD and default formats
const fiscal = new Fiscal();

// use asNumber to return a number value of the currency
fiscal.presentValue(50000, 10, 5).asNumber();
// 31046.07

// use asString to return a string value of the currency
fiscal.presentValue(50000, 10, 5).asString();
// "31046.07"

// use asFormattedString to return a string value formatted by default with en-US as
// the language code and USD as the currency code
fiscal.presentValue(50000, 10, 5).asFormattedString();
// $31,046.07

// You can pass a currency code as the first argument to get that format in currency
fiscal.presentValue(50000, 10, 5).asFormattedString("EUR");
// €31,046.07

// You can pass a language code as the second argument to get the language format included with the currency
fiscal.presentValue(50000, 10, 5).asFormattedString("EUR", "de-DE");
// 31.046,07 €

Specify a Currency and Language Code on Init

const fiscal = new Fiscal({
    format: {
        languageCode: "de-DE",
        currencyCode: "EUR"
    }
});

let formattedCurrency = fiscal.compoundInterest(92000, 7.5, 31).asFormattedString();
// => 865.865,07 €

// You can still override your options by providing the language and currecy codes in the .asFormattedString() method on the Currency Class
let formattedCurrency = fiscal.compoundInterest(92000, 7.5, 31).asFormattedString("USD", "en-US");
// => $865,865.07

Working with Percents

const fiscal = new Fiscal();

fiscal.discountFactor(6, 5).asDecimal(); // => 0.75
fiscal.discountFactor(6, 5).asString(); // => "75%"

API

Present Value (PV)

Present value (PV) is the current value of a future sum of money or stream of cash flows given a specified rate of return.

fiscal.presentValue(terminalValue: number, rate: number, numberOfYears: number): Currency

Future Value (FV)

Future value, or FV, is what money is expected to be worth in the future.

fiscal.futureValue(principal: number, rate: number, numberOfIntervals: number): Currency

Net Present Value (NPV)

Net present value or (NPV) is the present value of the cash flows at the required rate of return of your project compared to your initial investment.

fiscal.netPresentValue(principal: number, rate: number, cashFlows: number[]): Currency

Compound Interest (CI)

Compound interest (or compounding interest) is the interest on a loan or deposit calculated based on both the initial principal and the accumulated interest from previous periods.

fiscal.compountInterest(principal: number, rate: number , numberOfYears: number): Percent

Simple Interest (SI)

Simple interest is a method to calculate the amount of interest charged on a sum at a given rate and for a given period of time.

fiscal.simpleInterest(principal: number, rate: number, numberOfYears: number): Percent

Internal Rate of Return (IRR)

The internal rate of return (IRR) is a metric used in financial analysis to estimate the profitability of potential investments. IRR is a discount rate that makes the net present value (NPV) of all cash flows equal to zero in a discounted cash flow analysis.

fiscal.internalRateOfReturn(principal: number, cashflows: number[]): Percent

Discounted Cash Flow (DCF)

Discounted cash flow (DCF) is a valuation method used to estimate the value of an investment based on its expected future cash flows. DCF analysis attempts to figure out the value of an investment today, based on projections of how much money it will generate in the future.

fiscal.discountedCashFlow(principal:number, cashflows: number[], rate: number): Currency

Return on Investment (ROI)

Return on Investment (ROI) is a popular profitability metric used to evaluate how well an investment has performed

fiscal.returnOnInvestment(initialInvestment: number, earnings: number): Percent

Compounded Annual Growth Rate (CAGR)

Compound annual growth rate, or CAGR, is the mean annual growth rate of an investment over a specified period of time longer than one year.

fiscal.compoundedAnnualGrowthRate(initialInvestment: number, terminalValue: number, numberOfYears: number): Percent

Amortiation (AM)

Amortization is paying off a debt over time in equal installments. Part of each payment goes toward the loan principal, and part goes toward interest. With mortgage loan amortization, the amount going toward principal starts out small, and gradually grows larger month by month.

fiscal.amortization(principal: number, rate: number, totalNumberOfPayments: number, intervalInMonths: boolean = false, includeInitialPayment: boolean = false): Currency

Leverage Ratio (LR)

The leverage ratio is the proportion of debts that a bank has compared to its equity/capital

fiscal.leverageRatio(liabilities: number, debts: number, totalIncome: number): number

Inflation Adjusted Return (IAR)

The inflation-adjusted return is the measure of return that takes into account the time period's inflation rate.

fiscal.returnAdjustedForInflation(inflationRate: number, returnOnInvestment: number): Percent

Weighted Average Cost of Capital (WACC)

The weighted average cost of capital represents the average cost to attract investors, whether they're bondholders or stockholders. The calculation weights the cost of capital based on how much debt and equity the company uses, which provides a clear hurdle rate for internal projects or potential acquisitions.

fiscal.weightedAverageCostOfCapital(marketValueOfEquity: number, marketValueOfDebt: number, costOfEquity: number, costOfDebt: number, corporateTaxRate: number): Currency

Discount Factor (DF)

Discount Factor is used to calculate what the value of receiving $1 at some point in the future would be (the present value, or “PV”) based on the implied date of receipt and the discount rate assumption.

fiscal.discountFactor(rate: number, numberOfIntervals: number): Percent

Capital Asset Pricing Model (CAPM)

The capital asset pricing model provides a formula that calculates the expected return on a security based on its level of risk. The formula for the capital asset pricing model is the risk-free rate plus beta times the difference of the return on the market and the risk-free rate.

fiscal.capitalAssetPricingModel(riskFreeRate: number, expectedMarketReturn: number, beta: number): Percent

Profitability Index (PI)

The profitability index (PI) is a measure of a project's or investment's attractiveness. The PI is calculated by dividing the present value of future expected cash flows by the initial investment amount in the project.

fiscal.profitabilityIndex(principal: number, rate: number, cashFlows: number[]): number

Return on Equity (ROE)

Return on equity (ROE) is a measure of financial performance calculated by dividing net income by shareholders' equity

fiscal.returnOnEquity(netIncome: number, shareHoldersEquity: number): Percent

Rule of 72

The Rule of 72 is a simple formula used to estimate the length of time required to double an investment. The rule of 72 is primarily used in off the cuff situations where an individual needs to make a quick calculation instead of working out the exact time it takes to double an investment.

fiscal.ruleOf72(rate: number): number

Salary Per Year

Calculate a yearly salary by providing the hourly rate and the tax rate

fiscal.getSalaryPerYear(hourlyRate: number, taxRate: number): Currency;

Salary Per Month

Calculate a monthly salary by providing the hourly rate and the tax rate

fiscal.getSalaryPerMonth(hourlyRate: number, taxRate: number): Currency;

Hourly Wage

Determine your hourly wage based on the salary

fiscal.getHourlyWage(salary: number): Currency;

Year Over Year

Year over year (YOY) is a financial formula that represents the annual increase or decrease for a particular metric

fiscal.yearOverYear(currentYear: number, pastYear: number): Percent;

Percent Of

Find the percent of a certain value

fiscal.percentOf(percent: number, value: number): Currency;