1.0.0 • Published 7 months ago

prashant-currency-converter v1.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
7 months ago

A simple NPM package for currency conversion created by Prashant Ghadiali. This package is created for learning purposes and is not recommended for production use.

Installation

Install the package using npm:

npm install prashant-currency-converter

Import

To use the package, import the convertCurrency function:

import { convertCurrency } from 'prashant-currency-converter';

Usage

Example

import { convertCurrency } from 'prashant-currency-converter';

convertCurrency('USD', 'INR', 4)
    .then(result => console.log(`Converted Amount: ₹${result.toFixed(2)}`))
    .catch(error => console.error('Conversion Error:', error.message));

Parameters

  • from: The currency code to convert from (e.g., USD).
  • to: The currency code to convert to (e.g., INR).
  • amount: The amount to convert.

Returns

A Promise that resolves to the converted amount as a number.

Example Output

Converted Amount: ₹330.92

Environment Setup

This package requires an API key from Freecurrencyapi. Create a .env file in your project root and add your API key:

PRASHANT_API_KEY=your_api_key_here

Notes

  • Ensure your .env file is properly set up and contains a valid API key.
  • This package relies on the Freecurrencyapi service. Network issues or API restrictions may affect its functionality.

Limitations

  • This package is for educational purposes only and may not handle all edge cases.
  • Not suitable for high-accuracy financial calculations or production systems.

License

MIT License

1.0.0

7 months ago