moneyfunx 1.0.0 → 1.0.1

package/build/lib/loan.js

@@ -42,9 +42,7 @@ export class Loan {
         if (payment < this.minPayment) {
             throw new errors.PaymentTooLowError(`payment of ${payment} cannot be less than ${this.minPayment}`);
         }
-        else {
-            return payment;
-        }
+        return payment;
     }
     /**
      * Calculates the minimum payment to pay off the loan in the required number of periods
@@ -93,10 +91,10 @@ export class Loan {
      */
     interestPaid(periods, payment = this.minPayment, principal = this.principal) {
         this.validatePayment(payment);
-        const pmtsToZero = this.numPaymentsToZero(payment, principal);
-        return periods < pmtsToZero
+        const paymentsToZero = this.numPaymentsToZero(payment, principal);
+        return periods < paymentsToZero
             ? helpers.interestPaid(principal, payment, this.periodicRate, periods)
-            : helpers.interestPaid(principal, payment, this.periodicRate, pmtsToZero - 1) +
-                this.accrueInterest(this.principalRemaining(pmtsToZero - 1, payment, principal));
+            : helpers.interestPaid(principal, payment, this.periodicRate, paymentsToZero - 1) +
+                this.accrueInterest(this.principalRemaining(paymentsToZero - 1, payment, principal));
     }
 }

package/build/lib/payments.d.ts

@@ -23,6 +23,7 @@ export declare function determineExtraPayment(loans: ILoan[], payment: number):
  * @param {number} payment The amount to pay to the loan's balance each period
  * @param {number} numPayments The number of periods to make payments to the loan
  * @param {number} startPeriod An initial offset of periods to 'fast-forward' the state of the loan to prior to calculation of each period
+ * @param {number} carryover An additional amount to pay towards a loan, used when a residual amount is available from paying off the previous loan this period
  * @returns {Array<AmortizationRecord>} The amortization schdule for the number of payments of payment made to the loan from the provided start period
  */
 export declare function amortizePayments(loan: Loan, principal: number, payment: number, numPayments: number, startPeriod?: number, carryover?: number): AmortizationRecord[];

package/build/lib/payments.js

@@ -30,6 +30,7 @@ export function determineExtraPayment(loans, payment) {
  * @param {number} payment The amount to pay to the loan's balance each period
  * @param {number} numPayments The number of periods to make payments to the loan
  * @param {number} startPeriod An initial offset of periods to 'fast-forward' the state of the loan to prior to calculation of each period
+ * @param {number} carryover An additional amount to pay towards a loan, used when a residual amount is available from paying off the previous loan this period
  * @returns {Array<AmortizationRecord>} The amortization schdule for the number of payments of payment made to the loan from the provided start period
  */
 export function amortizePayments(loan, principal, payment, numPayments, startPeriod = 0, carryover = 0) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "moneyfunx",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "MoneyFunx is a small library of functions for financial computations, with a focus on personal finance",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/src/lib/loan.ts

@@ -79,9 +79,8 @@ export class Loan implements ILoan {
       throw new errors.PaymentTooLowError(
         `payment of ${payment} cannot be less than ${this.minPayment}`
       );
-    } else {
-      return payment;
     }
+    return payment;
   }
 
   /**
@@ -155,17 +154,17 @@ export class Loan implements ILoan {
     principal: number = this.principal
   ): number {
     this.validatePayment(payment);
-    const pmtsToZero = this.numPaymentsToZero(payment, principal);
-    return periods < pmtsToZero
+    const paymentsToZero = this.numPaymentsToZero(payment, principal);
+    return periods < paymentsToZero
       ? helpers.interestPaid(principal, payment, this.periodicRate, periods)
       : helpers.interestPaid(
         principal,
         payment,
         this.periodicRate,
-        pmtsToZero - 1
+        paymentsToZero - 1
       ) +
       this.accrueInterest(
-        this.principalRemaining(pmtsToZero - 1, payment, principal)
+        this.principalRemaining(paymentsToZero - 1, payment, principal)
       );
   }
 }

package/src/lib/payments.ts

@@ -47,6 +47,7 @@ export function determineExtraPayment(
  * @param {number} payment The amount to pay to the loan's balance each period
  * @param {number} numPayments The number of periods to make payments to the loan
  * @param {number} startPeriod An initial offset of periods to 'fast-forward' the state of the loan to prior to calculation of each period
+ * @param {number} carryover An additional amount to pay towards a loan, used when a residual amount is available from paying off the previous loan this period
  * @returns {Array<AmortizationRecord>} The amortization schdule for the number of payments of payment made to the loan from the provided start period
  */
 export function amortizePayments(