cash-register v1.0.3

cash-register

cash-register is a simple JavaScript module that helps you calculate and break down change owed after a transaction. It is designed with Canadian currency denominations in mind, considering the absence of pennies in Canada.

Installation

You can install cash-register via npm:

npm install cash-register

Usage

Import the module into your JavaScript code:

const { calculateTotalChange, calculateRoundedChange, calculateChangeBreakdown } = require('cash-register');

Calculate Total Change

The calculateTotalChange function calculates the total change by subtracting the total amount due from the total money received.

const totalChange = calculateTotalChange(totalDue, moneyReceived);

Calculate Rounded Change

The calculateRoundedChange function calculates the change by rounding to the nearest 0.05. This is suitable for handling Canadian currency without pennies.

const roundedChange = calculateRoundedChange(totalDue, moneyReceived);

Calculate Change Breakdown

The calculateChangeBreakdown function provides a breakdown of the change, specifying the number of each coin denomination owed as change. This function is suitable for Canadian currency where there are loonies and toonies, but no pennies.

const changeBreakdown = calculateChangeBreakdown(totalDue, moneyReceived);

Example

const { calculateTotalChange, calculateRoundedChange, calculateChangeBreakdown } = require('cash-register');

const totalDue = 10.0;
const moneyReceived = 20.0;

const totalChange = calculateTotalChange(totalDue, moneyReceived);
const roundedChange = calculateRoundedChange(totalDue, moneyReceived);
const changeBreakdown = calculateChangeBreakdown(totalDue, moneyReceived);

console.log(`Total Change: $${totalChange}`);
console.log(`Rounded Change: $${roundedChange}`);
console.log(changeBreakdown);

Output

Total Change: $10.0
Rounded Change: $10.0
You need to dispense 5 toonies.