@prazzol/currency-formatter/README.md

Format currency in Nepali and international styles with custom prefix support.

# @prazzol/currency-formatter

A simple and powerful currency formatter for Nepali, International, and any locale-based formats. Useful for applications needing localized number formatting and currency symbols like `रू`, `$`, `€`, etc.

---

## ✨ Features

- 🇳🇵 Nepali number format (e.g., `12,34,567`)
- 🌐 International format (e.g., `1,234,567`)
- 🌍 Locale + currency code support (e.g., `₹12,34,567`, `$1,234,567`)
- 🔣 Optional or custom currency prefix (like `रू`, `Rs`, `$`, `€`)
- 🔒 Fully written in **TypeScript**

---

## 📦 Installation

```bash
npm install @prazzol/currency-formatter
```

## 📚 Usage
```bash
import { formatCurrency } from '@prazzol/currency-formatter';

formatCurrency(1234567);
// → रू 12,34,567

formatCurrency(1234567, { showPrefix: false });
// → 12,34,567

formatCurrency(1234567, { prefix: '$', format: 'international' });
// → $ 1,234,567

formatCurrency(1234567, {
  format: 'locale',
  locale: 'en-US',
  currency: 'USD'
});
// → $1,234,567
```

## 🧰 API
formatCurrency(amount: number, options?: CurrencyFormatOptions): string

| Property     | Type                                      | Default    | Description                                         |
| ------------ | ----------------------------------------- | ---------- | --------------------------------------------------- |
| `format`     | `'nepali' \| 'international' \| 'locale'` | `'nepali'` | Choose format style                                 |
| `prefix`     | `string`                                  | `'रू'`     | Custom prefix (e.g., `'$', 'Rs', '€'`)              |
| `showPrefix` | `boolean`                                 | `true`     | Whether to show the prefix                          |
| `locale`     | `string`                                  | `'en-US'`  | Locale (only used if `format` is `'locale'`)        |
| `currency`   | `string`                                  | `'NPR'`    | Currency code (only used if `format` is `'locale'`) |


## 🔄 Format Types

### 🏷 Nepali Format
```bash
formatCurrency(1234567);
// → रू 12,34,567
```

### 🗺 International Format
```bash
formatCurrency(1234567, {
  prefix: '$',
  format: 'international'
});
// → $ 1,234,567

```

### 🌍 Locale Format (Fully Automatic)
```bash
formatCurrency(1234567, {
  format: 'locale',
  locale: 'fr-FR',
  currency: 'EUR'
});
// → 1 234 567 €

formatCurrency(1234567, {
  format: 'locale',
  locale: 'hi-IN',
  currency: 'INR'
});
// → ₹12,34,567

```

## 🧪 Running Locally for Development
```bash
npm install
npm run test
```