https://github.com/subhadeeproy3902/cash-changer
https://github.com/subhadeeproy3902/cash-changer
npm package
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/subhadeeproy3902/cash-changer
- Owner: subhadeeproy3902
- License: apache-2.0
- Created: 2024-11-23T06:00:39.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-11-24T07:58:38.000Z (6 months ago)
- Last Synced: 2025-03-27T14:52:24.663Z (2 months ago)
- Topics: npm, package
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/cash-changer/
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cash Changer 💱
`Cash Changer` is a simple, fast, and reliable Node.js library for converting currencies using the [Free Currency API](https://freecurrencyapi.com/). With minimal setup, you can integrate this package to perform currency conversions in your application.
Find it out here:
---
## Features ✨
- 🚀 **Fast**: Fetch real-time exchange rates.
- 🧩 **Easy-to-Use**: Simple API for hassle-free integration.
- 🌍 **Wide Coverage**: Supports all major world currencies.
- 📡 **Accurate Data**: Powered by [Free Currency API](https://freecurrencyapi.com/).
---
## Installation 🔧
Install the package using npm:
```bash
npm install cash-changer
```
## Usage 📘
Here's how you can use Cash Changer in your project:
### 1. Import the Package
```javascript
import {convertCurrency} from "cash-changer";
```
### 2. Perform Currency Conversion
```javascript
convertCurrency("USD", "EUR", 100).then((result) => {
console.log(result);
});
```
## API Reference 🌐
### `convertCurrency(fromCurrency, toCurrency, units)`
- **Description**: Converts a given amount from one currency to another using the latest exchange rates.
- **Parameters**:
- `fromCurrency` (string): The base currency (e.g., `USD`).
- `toCurrency` (string): The target currency (e.g., `EUR`).
- `units` (number): The amount in the base currency.
- **Returns**: A `Promise` representing the converted amount.
## Requirements 📋
- **Node.js**: v12 or higher
Ensure you have Node.js installed on your system. You can download it from [nodejs.org](https://nodejs.org/).
## Contributing 🤝
We welcome contributions to make `Cash Changer` even better! If you have ideas, encounter bugs, or want to enhance the library, feel free to:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-name`).
3. Make your changes and commit (`git commit -m "Added feature-name"`).
4. Push to the branch (`git push origin feature-name`).
5. Open a pull request.
For major changes, please open an issue first to discuss what you’d like to change. Thank you for your support!
---
## License 📜
This project is licensed under the [Apache-2.0](./LICENSE).
You are free to use, modify, and distribute this library as per the license terms. See the LICENSE file for details.
## Support ❤️
If you find this package helpful, consider giving it a ⭐ on Github.
---