Class ForexClient

A client to interact with the Forex API for fetching currency rates and conversion data

Hierarchy (view full)

HttpClient
- ForexClient

Index

Constructors

constructor

new ForexClient(options?): ForexClient
Creates a new instance of ForexClient
Parameters
- Optionaloptions: ForexClientOptions = {}
  The options for configuring the client
Returns ForexClient
Overrides HttpClient.constructor
- Defined in src/services/forex-client.ts:35

Properties

`Protected` `Readonly`timeout

timeout: number

`Protected` `Readonly`headers

headers: HeadersInit

Methods

getCurrencies

getCurrencies(date?, options?): Promise<HttpResponse<AvailableCurrency[]>>
Fetches the list of available currencies
Parameters
- Optionaldate: Date | "latest" = 'latest'
  The date for fetching currencies, or "latest" for the most recent
- Optionaloptions: RequestInit = {}
  Additional request options
Returns Promise<HttpResponse<AvailableCurrency[]>>
A list of available currencies
Example
```
// => {
//    code: 200,
//    message: 'OK',
//    data: [
//        { code: 'eur', name: 'Euro' },
//        { code: 'usd', name: 'US Dollar' },
//        { code: 'cny', name: 'Chinese Yuan Renminbi' },
//        ... More items
//    ]
// }
new ForexClient().getCurrencies('latest');
```
- Defined in src/services/forex-client.ts:64

getRates

getRates(code?, date?, options?): Promise<HttpResponse<ExchangeRate[]>>
Fetches the exchange rates for a specific currency
Parameters
- Optionalcode: string = ...
  The currency code or locale code to get rates for
- Optionaldate: Date | "latest" = 'latest'
  The date for the rates, or 'latest' for the most recent
- Optionaloptions: RequestInit = {}
  Additional request options
Returns Promise<HttpResponse<ExchangeRate[]>>
A list of exchange rates
Example
```
// => {
//    code: 200,
//    message: 'OK',
//    data: [
//        { code: 'eur', rate: 100_000 },
//        { code: 'usd', rate: 100_000 },
//        { code: 'cny', rate: 100_000 },
//        ... More items
//    ]
// }
new ForexClient().getRates('BTC');
```
- Defined in src/services/forex-client.ts:99

getRate

getRate(baseCode?, destCode?, date?, options?): Promise<HttpResponse<number>>
Fetches the exchange rate between two currencies
Parameters
- OptionalbaseCode: string = ...
  The base currency code or locale code
- OptionaldestCode: string
  The destination currency code or locale code
- Optionaldate: Date | "latest" = 'latest'
  The date for the rate, or 'latest' for the most recent
- Optionaloptions: RequestInit = {}
  Additional request options
Returns Promise<HttpResponse<number>>
The exchange rate
Example
```
// => {
//    code: 200,
//    message: 'OK',
//    data: 100_000
// }
new ForexClient().getRate('BTC', 'USD');
```
- Defined in src/services/forex-client.ts:133

getCode

getCode(localeCode): string
Get a valid currency code based on locale
Parameters
- localeCode: string
  The locale code to get currency code for
Returns string
The corresponding currency code
Example
```
// => 'USD'
new ForexClient().getCode('US');
```
Example
```
// => 'CNH'
new ForexClient().getCode('HK');
```
Example
```
// => 'CNY'
new ForexClient().getCode('RMB');
```
- Defined in src/services/forex-client.ts:168

convert

convert(baseCode?, destCode?, amount?, date?, options?): Promise<HttpResponse<number>>
Converts an amount from one currency to another
Parameters
- OptionalbaseCode: string = ...
  The base currency code or locale code
- OptionaldestCode: string
  The destination currency code or locale code
- Optionalamount: string | number = 0
  The amount to convert
- Optionaldate: Date | "latest" = 'latest'
  The date for the conversion rate, or 'latest' for the most recent
- Optionaloptions: RequestInit = {}
  Additional request options
Returns Promise<HttpResponse<number>>
The converted amount
Example
```
// => {
//    code: 200,
//    message: 'OK',
//    data: 100_000
// }
new ForexClient().convert('BTC', 'USD', 1);
```
Example
```
// => {
//    code: 200,
//    message: 'OK',
//    data: 7.27
// }
new ForexClient().convert('US', 'HK', 1);
```
- Defined in src/services/forex-client.ts:197

`Protected`get

get<T>(url, options?): Promise<HttpResponse<T>>
Type Parameters
- T
Parameters
- url: string
- options: RequestInit = {}
Returns Promise<HttpResponse<T>>
Inherited from HttpClient.get
- Defined in src/utils/http-client.ts:9

`Protected`_fetch

_fetch<T>(options): Promise<HttpResponse<T>>
Type Parameters
- T = unknown
Parameters
- options: Request
Returns Promise<HttpResponse<T>>
Inherited from HttpClient._fetch
- Defined in src/utils/http-request.ts:17

Class ForexClient

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ForexClient

Properties

Protected Readonlytimeout

Protected Readonlyheaders

Methods

getCurrencies

Parameters

Returns Promise<HttpResponse<AvailableCurrency[]>>

Example

getRates

Parameters

Returns Promise<HttpResponse<ExchangeRate[]>>

Example

getRate

Parameters

Returns Promise<HttpResponse<number>>

Example

getCode

Parameters

Returns string

Example

Example

Example

convert

Parameters

Returns Promise<HttpResponse<number>>

Example

Example

Protectedget

Type Parameters

Parameters

Returns Promise<HttpResponse<T>>

Protected_fetch

Type Parameters

Parameters

Returns Promise<HttpResponse<T>>

Settings

On This Page

`Protected` `Readonly`timeout

`Protected` `Readonly`headers

`Protected`get

`Protected`_fetch