API reference
Functions
Section titled “Functions”| Name | Description |
|---|---|
createFrankfurterClient(options?) | Returns new FrankfurterClient(options) |
FrankfurterClient
Section titled “FrankfurterClient”Constructor
Section titled “Constructor”new FrankfurterClient(options?: FrankfurterClientOptions)
Methods
Section titled “Methods”| Method | Returns |
|---|---|
rates(query?, requestOptions?) | Promise<Rate[]> |
latest(options?, requestOptions?) | Promise<Rate[]> |
historical(date, options?, requestOptions?) | Promise<Rate[]> |
range(from, to?, options?, requestOptions?) | Promise<Rate[]> |
currencies(query?, requestOptions?) | Promise<Currency[]> |
providers(requestOptions?) | Promise<Provider[]> |
Errors
Section titled “Errors”FrankfurterError: failed HTTP response (status,statusText,url,body,headers)
Types (exported)
Section titled “Types (exported)”CurrenciesQuery, Currency, CurrencyCode, CurrencyScope, DateString, ErrorResponseBody, FrankfurterClientOptions, GroupBy, HistoricalRatesOptions, LatestRatesOptions, Listable, Provider, ProviderKey, RangeRatesOptions, Rate, RatesQuery, RequestOptions
For field-level detail, see types.ts in the repository.