Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/driaug/current-currency
Making it easy to work with currencies and cryptos!
https://github.com/driaug/current-currency
currency iso-currency npm rates typescript
Last synced: 2 months ago
JSON representation
Making it easy to work with currencies and cryptos!
- Host: GitHub
- URL: https://github.com/driaug/current-currency
- Owner: driaug
- Created: 2021-02-09T18:04:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-19T14:55:13.000Z (over 3 years ago)
- Last Synced: 2024-10-11T10:51:16.437Z (3 months ago)
- Topics: currency, iso-currency, npm, rates, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/current-currency
- Size: 134 KB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# current-currency šµš¶š·
Making it easy to work with currencies and cryptos!
## Summary
- [Getting Started](#getting-started)
- [Available functions](#Available-functions)
- [Supported currencies](#Supported-currencies)
- [Supported cryptocurrencies](#Supported-cryptocurrencies)
## Getting Started
Install current-currency with your favourite package manager.
- `npm install current-currency`
- `yarn add current-currency`
## Available functions
### convert
Convert is used to get the current rates of a currency.
#### Example
```ts
import { convert } from "current-currency";
convert("EUR", 10.2, "USD").then(res => console.log(res));
// {currency: "USD", amount: 12.35}
```
In the background we make use of https://exchangeratesapi.io/ to always have the current rates.
### addSymbol
AddSymbol is used to add the right currency symbol in the right position using the ISO currency code.
#### Example
```ts
import { addSymbol } from "current-currency";
const symbolized = addSymbol("RUB", 10.2);
console.log(symbolized);
// ā½10.2
```
#### Example with force position
```ts
import { addSymbol } from "current-currency";
const symbolized = addSymbol("USD", 10.2, "post");
console.log(symbolized);
// 10.2$
```
### extract
Extract is used to retrieve information about a currency using the ISO currency code.
#### Example
```ts
import { extract } from "current-currency";
const extraction = extract("10.2RUB");
console.log(extraction);
// { type: "currency", name: "Russian ruble", symbol: "ā½", decimal: ",", position: "pre" }
```
## Supported currencies
| Code | Name |
|------|----------------------|
| EUR | Euro |
| USD | United States Dollar |
| CAD | Canadian Dollar |
| HKD | Hong Kong Dollar |
| ISK | Icelandic KrĆ³na |
| PHP | Philippine Peso |
| DDK | Danish Krone |
| HUF | Hungarian Forint |
| CZK | Czech Koruna |
| AUD | Australian Dollar |
| RON | Romanian Leu |
| SEK | Swedish Krona |
| IDR | Indonesian Rupiah |
| INR | Indian Rupee |
| BRL | Brazilian Real |
| RUB | Russian Ruble |
| HRK | Croatian Kuna |
| JPY | Japanse Yen |
| TBH | Thai Baht |
| CHF | Swiss Franc |
| SGD | Singapore Dollar |
| PLN | Polish zÅoty |
| BGN | Bulgarian Lev |
| TRY | Turkish Lira |
| CNY | Chinese Renminbi |
| NOK | Norwegian Krone |
| NZD | New Zealand Dollar |
| ZAR | South African Rand |
| MXN | Mexican Peso |
| ILS | Israeli Shekel |
| GBP | Pound Sterling |
| KRW | South Korean Won |
| MYR | Malaysian Ringgit |
## Supported cryptocurrencies
| Code | Name |
|------|----------------------|
| BTC | Bitcoin |
| ETH | Ethereum |
| LTC | Litecoin |
| XRP | Ripple |
| DOGE | Dogecoin |