ICurrencyRateProvider
katanakit-js / ICurrencyRateProvider
Interface: ICurrencyRateProvider
Section titled “Interface: ICurrencyRateProvider”Defined in: types/core/currency-conversion.ts:18
Port for fetching exchange rates from an external source.
Lives at the hexagonal boundary: implementations perform the runtime I/O
(src/infrastructure/), while the core only depends on this contract.
Implementations never throw — every failure comes back as a
SafeResult, so the facade keeps its no-throw promise whatever
provider is plugged in.
Methods
Section titled “Methods”useFetchRates()
Section titled “useFetchRates()”useFetchRates(base, quotes?): Promise<SafeResult<{ base: | "USD" | "EUR" | "GBP" | "JPY" | "CHF" | "CAD" | "AUD" | "NZD" | "MXN" | "BRL" | "ARS" | "COP" | "CLP" | "SEK" | "NOK" | "DKK" | "PLN" | "CZK" | "HUF" | "RON" | "TRY" | "ISK" | "CNY" | "HKD" | "SGD" | "INR" | "KRW" | "THB" | "IDR" | "MYR" | "PHP" | "ILS" | "ZAR"; date: string; rates: Record<string, number>;}>>;Defined in: types/core/currency-conversion.ts:26
Returns a dated rate snapshot quoted against base.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
base |
| "USD" | "EUR" | "GBP" | "JPY" | "CHF" | "CAD" | "AUD" | "NZD" | "MXN" | "BRL" | "ARS" | "COP" | "CLP" | "SEK" | "NOK" | "DKK" | "PLN" | "CZK" | "HUF" | "RON" | "TRY" | "ISK" | "CNY" | "HKD" | "SGD" | "INR" | "KRW" | "THB" | "IDR" | "MYR" | "PHP" | "ILS" | "ZAR" |
Currency the rates are quoted against. |
quotes? |
( | "USD" | "EUR" | "GBP" | "JPY" | "CHF" | "CAD" | "AUD" | "NZD" | "MXN" | "BRL" | "ARS" | "COP" | "CLP" | "SEK" | "NOK" | "DKK" | "PLN" | "CZK" | "HUF" | "RON" | "TRY" | "ISK" | "CNY" | "HKD" | "SGD" | "INR" | "KRW" | "THB" | "IDR" | "MYR" | "PHP" | "ILS" | "ZAR")[] |
Optional subset of quote currencies. Omit for every rate the source knows. |
Returns
Section titled “Returns”Promise<SafeResult<{
base: | "USD"
| "EUR"
| "GBP"
| "JPY"
| "CHF"
| "CAD"
| "AUD"
| "NZD"
| "MXN"
| "BRL"
| "ARS"
| "COP"
| "CLP"
| "SEK"
| "NOK"
| "DKK"
| "PLN"
| "CZK"
| "HUF"
| "RON"
| "TRY"
| "ISK"
| "CNY"
| "HKD"
| "SGD"
| "INR"
| "KRW"
| "THB"
| "IDR"
| "MYR"
| "PHP"
| "ILS"
| "ZAR";
date: string;
rates: Record<string, number>;
}>>
{ data, error, ok } with the snapshot or the source failure.