Skip to content

Main content

Water Cost Calculator Source Code

Browse the implementation files for Water Cost Calculator.
@tool.io/tools/cost/water source ↗
tool.ts typescript
import {
	CURRENCY_OPTIONS,
	formatCostSummary,
	formatMoney,
	parseCurrency,
	parseNonnegative,
	parsePositive
} from '../calculation';
import { calculateWaterCost } from '@tool.io/tools/cost/water';

export const waterCost = (
	currencyInput: unknown,
	unitsInput: unknown,
	dailyUsageInput: unknown,
	daysInput: unknown,
	rateInput: unknown,
	fixedChargeInput: unknown
): string => {
	if (unitsInput !== 'us' && unitsInput !== 'metric') return '';
	const currency = parseCurrency(currencyInput);
	const dailyUsage = parseNonnegative(dailyUsageInput);
	const days = parsePositive(daysInput);
	const rate = parseNonnegative(rateInput);
	const fixed = parseNonnegative(fixedChargeInput);
	if (
		!currency ||
		dailyUsage === null ||
		days === null ||
		rate === null ||
		fixed === null
	)
		return '';
	const result = calculateWaterCost(
		unitsInput,
		dailyUsage,
		days,
		rate,
		fixed,
		currency
	);
	if (!result) return '';
	return formatCostSummary([
		[
			'Water used',
			`${result.usage.toFixed(2)} ${result.usageUnit}`
		],
		['Usage cost', formatMoney(result.usageCost, currency)],
		['Fixed charge', formatMoney(result.fixedCharge, currency)],
		['Total cost', formatMoney(result.totalCost, currency)]
	]);
};

export const Tool: TypeTool = {
	name: 'Water Cost Calculator',
	slug: 'cost/water',
	intro:
		'Estimate a water bill from daily usage, billing days, usage rates, and fixed charges.',
	tool: waterCost,
	i: [
		{
			example: 'USD',
			label: 'Currency',
			options: CURRENCY_OPTIONS,
			placeholder: 'Select currency',
			type: 'select'
		},
		{
			example: 'us',
			label: 'Units and Rate',
			options: [
				{
					selected: true,
					text: 'US — gallons and price/1,000 gal',
					value: 'us'
				},
				{
					text: 'Metric — liters and price/m³',
					value: 'metric'
				}
			],
			placeholder: 'Select units',
			type: 'select'
		},
		{
			example: '100',
			label: 'Daily Usage',
			placeholder: 'Water used per day',
			type: 'number'
		},
		{
			example: '30',
			label: 'Billing Days',
			placeholder: 'Days in bill',
			type: 'number'
		},
		{
			example: '6',
			label: 'Usage Rate',
			placeholder: 'Price per 1,000 gal or m³',
			type: 'number'
		},
		{
			example: '15',
			label: 'Fixed Charge',
			placeholder: 'Fixed bill charge',
			type: 'number'
		}
	],
	o: [
		{
			example:
				'Water used: 3000.00 gal\nUsage cost: $18.00\nFixed charge: $15.00\nTotal cost: $33.00',
			label: 'Water Cost',
			placeholder: 'Water costs will appear here...',
			render: 'textarea',
			type: 'text'
		}
	],
	cite: [
		{
			title: 'Water metering - Wikipedia',
			url: 'https://en.wikipedia.org/wiki/Water_metering'
		}
	]
};
export default Tool;

Description

Browse the implementation files for Water Cost Calculator.

References

  1. Tool.io on GitHub
  2. Tool.io TypeScript tools library

Similar or alternative tools