effective-rent
v1.0.0
Published
Calculate your rent in a given 4 week pay period
Downloads
10
Readme
effective-rent
Calculate your rent in a given pay period.
Motivation
Rent is typically paid on a per-month basis, but different months have different numbers of days. Therefore, the amount you pay each day in rent is not constant; it depends on the month.
Contrast this with biweekly pay-checks, which are distributed every 2 weeks, and are independent of the number of days in a given month.
The challenge that this library solves is determining how much of each paycheck goes toward your rent. Approximating 4 weeks (2 pay checks) per month is fine for short time scales, but is inadequate for long-term calculations. For instance, over the course of a year that approximation counts a whole extra month of rent for the year.
This library calculates exactly how much of a given paycheck is going toward rent.
Installation
The preferred installation method is through npm
.
npm install effective-rent
Example Usage
import effectiveRent from 'effective-rent';
// A pay date of January 1st, 2016
const payDate = new Date(2016, 0, 1);
// A rent of $2000 per month
const rent = 2000;
effectiveRent.compute({rent, payDate});
// => '903.23'
API
effectiveRent.compute(options)
Computes the effective rent given options
. There are two valid options:
payDate
- a JavaScript Date object representing the date that you were paidrent
- how much your rent is each month
Returns a string representing the effective rent for that paycheck.