Currency Formatter

A simple utility to format numbers as currency with commas and optional currency symbols.

Installation

You can install this package using npm:

npm i haseeb-curreccny-formator

Usage

This package provides a function to format numbers as currency. By default, it uses the dollar symbol ($), but you can also specify other currency symbols (e.g., €, ₹, £).

Basic Usage

To format a number as currency with the default dollar sign:

const formatCurrency = require('currency-formatter');

console.log(formatCurrency(1234567.89)); 
// Output: $1,234,567.89

Custom Currency Symbol

You can also pass a custom currency symbol to the function:

console.log(formatCurrency(1234567.89, '€')); 
// Output: €1,234,567.89

console.log(formatCurrency(500, '₹')); 
// Output: ₹500.00

console.log(formatCurrency(1000000, '£')); 
// Output: £1,000,000.00

Handling Invalid Input

The function will throw an error if the input is not a valid number:

try {
  console.log(formatCurrency('invalid input'));
} catch (e) {
  console.log('Error:', e.message); 
  // Output: Error: Input must be a valid number
}

API

formatCurrency(amount, currencySymbol)

1. amount (number): The number to format as currency.
2. currencySymbol (string, optional): The currency symbol to use. Defaults to $ if not provided.

Returns:

A string representing the formatted currency with commas and the specified currency symbol.

Example

const formatCurrency = require('currency-formatter');

console.log(formatCurrency(1234567.89)); // Output: $1,234,567.89
console.log(formatCurrency(9876543210)); // Output: $9,876,543,210.00
console.log(formatCurrency(1234.56, '£')); // Output: £1,234.56
console.log(formatCurrency(1000000, '₹')); // Output: ₹1,000,000.00

License

MIT License

---

### How This Works:

1. **Installation**: The package can be installed via npm.
2. **Usage**: Provides an easy-to-use function to format numbers into currency format, with an optional argument for specifying the currency symbol.
3. **API**: Clear explanation of the function signature, what parameters are required, and the return value.
4. **Example**: A simple example with various currencies and possible errors.

Let me know if you'd like to modify or add anything! 😄