1.0.1 โ€ข Published 5 months ago

exchangenow v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
5 months ago

ExchangeNow ๐ŸŒ๐Ÿ’ฑ

Your go-to currency conversion tool ๐Ÿ’ธ

With ExchangeNow, you can easily convert currencies on the fly by fetching real-time exchange rates. This simple, lightweight package uses the power of axios and cheerio to provide the latest conversion rates.

No more manual searching for up-to-date exchange rates. Just use ExchangeNow and let the magic happen! โœจ


Installation โšก๏ธ

To get started with ExchangeNow, you need to install the package via npm. Run the following command:

npm install exchangenow

Usage ๐Ÿ’ป

Once installed, you can start converting currencies right away! Here's how:

1. Import the package

const { convert } = require('exchangenow');

2. Convert currencies

To convert a specific amount from one currency to another, just use the convert() function.

const convertRate = async () => {
  try {
    const response = await convert('USD', 'EUR', 100);
    console.log(response.exchangeRate);  // Logs the exchange rate for USD to EUR
  } catch (error) {
    console.error('Error:', error.message);
  }
};

Parameters:

  • from (string): The 3-letter ISO 4217 currency code of the source currency (e.g., 'USD', 'EUR', 'GBP').
  • to (string): The 3-letter ISO 4217 currency code of the target currency (e.g., 'USD', 'JPY', 'INR').
  • amount (number): The amount you want to convert. The default value is 1.

Example Output:

{
  "exchangeRate": "current conversion rate"
}

Error Handling โ—

ExchangeNow throws errors when the following conditions are met:

  • Missing or invalid from or to parameters.
  • Invalid currency codes (must follow ISO 4217 format).
  • Amount is not a positive number.

Make sure to handle these errors gracefully in your code.


Features ๐ŸŒŸ

  • Converts any two valid ISO 4217 currency codes.
  • Scrapes real-time exchange rates.
  • Easy-to-use, lightweight, and fast.
  • Handles errors in case of invalid inputs.

Development ๐Ÿš€

Want to contribute to ExchangeNow? Awesome! ๐ŸŽ‰ Here's how you can get started:

  1. Clone the repo:
git clone git@github.com:Konain-Raza/ExchangeNow.git
cd ExchangeNow
  1. Install dependencies:
npm install
  1. Make your changes and improvements.
  2. Submit a pull request!

License ๐Ÿ“

ExchangeNow is licensed under the MIT Licenseโ€”feel free to use it, modify it, and make it better. Just don't sell it as your own! ๐Ÿ˜Ž


Made with โค๏ธ by KonainRaza