From d61c304a8e48a382067c35798919d2191615c071 Mon Sep 17 00:00:00 2001 From: kabeep Date: Wed, 11 Dec 2024 20:46:42 +0800 Subject: [PATCH] docs: update version 1.0.1 --- docs/classes/index.ForexClient.html | 14 +++++++------- docs/classes/index._internal_.HttpClient.html | 4 ++-- docs/classes/index._internal_.HttpRequest.html | 4 ++-- docs/documents/____.html | 9 +++++++-- docs/index.html | 9 +++++++-- docs/interfaces/index.AvailableCurrency.html | 4 ++-- docs/interfaces/index.ExchangeRate.html | 4 ++-- docs/interfaces/index.ForexClientOptions.html | 4 ++-- docs/interfaces/index.HttpRequestOptions.html | 4 ++-- docs/interfaces/index.HttpResponse.html | 4 ++-- docs/modules/index.html | 2 +- docs/types/index.OriginalExchangeRates.html | 2 +- docs/variables/index.BASE_URL.html | 2 +- docs/variables/index.BASE_URL_VERSION.html | 2 +- docs/variables/index.LOCALE_CURRENCY.html | 2 +- docs/variables/index.NON_STANDARD_CODES.html | 2 +- 16 files changed, 41 insertions(+), 31 deletions(-) diff --git a/docs/classes/index.ForexClient.html b/docs/classes/index.ForexClient.html index 6ee1cd7..fd961de 100644 --- a/docs/classes/index.ForexClient.html +++ b/docs/classes/index.ForexClient.html @@ -157,7 +157,7 @@ --md-sys-color-surface-container-highest: #e6e1e6 }

Class ForexClient

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

timeout headers

Methods

getCurrencies @@ -169,14 +169,14 @@ _fetch

Constructors

constructor

Properties

Protected Readonlytimeout

timeout: number

Protected Readonlyheaders

headers: HeadersInit

Methods

getCurrencies

Returns ForexClient

Properties

Protected Readonlytimeout

timeout: number

Protected Readonlyheaders

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');
    -

getRates

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

      @@ -184,7 +184,7 @@

      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');
      -

getRate

  • getRate(baseCode?, destCode?, date?, options?): Promise<HttpResponse<number>>

  • Fetches the exchange rate between two currencies

    +

getRate

getCode

getCode

convert

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

      @@ -218,7 +218,7 @@

      Example

      // => {
      //    code: 200,
      //    message: 'OK',
      //    data: 7.27
      // }
      new ForexClient().convert('US', 'HK', 1);
      -

Protectedget

Protected_fetch

Settings

Member Visibility

On This Page

Constructors
Properties
Methods

Class HttpClient

Hierarchy (view full)

Constructors

constructor +

Class HttpClient

Hierarchy (view full)

Constructors

constructor

Properties

timeout headers

Methods

get _fetch -

Constructors

constructor

Properties

Protected Readonlytimeout

timeout: number

Protected Readonlyheaders

headers: HeadersInit

Methods

Protectedget

Protected_fetch

Settings

Member Visibility

On This Page

Constructors
Properties
Methods

Class HttpRequest

Hierarchy (view full)

Constructors

constructor +

Class HttpRequest

Hierarchy (view full)

Constructors

constructor

Properties

timeout headers

Methods

_fetch -

Constructors

constructor

Properties

Protected Readonlytimeout

timeout: number

Protected Readonlyheaders

headers: HeadersInit

Methods

Protected_fetch

Settings

Member Visibility

On This Page

Constructors
Properties
Methods

Interface AvailableCurrency

interface AvailableCurrency {
    code: string;
    name: string;
}

Properties

code +

Interface AvailableCurrency

interface AvailableCurrency {
    code: string;
    name: string;
}

Properties

code name -

Properties

code

code: string

name

name: string

Settings

Member Visibility

On This Page

Properties

Interface ExchangeRate

interface ExchangeRate {
    code: string;
    rate: number;
}

Properties

code +

Interface ExchangeRate

interface ExchangeRate {
    code: string;
    rate: number;
}

Properties

code rate -

Properties

code

code: string

rate

rate: number

Settings

Member Visibility

On This Page

Properties

Interface ForexClientOptions

interface ForexClientOptions {
    baseCurrency?: string;
    minified?: boolean;
    timeout?: number;
    headers?: HeadersInit;
}

Hierarchy (view full)

Properties

baseCurrency? +

Interface ForexClientOptions

interface ForexClientOptions {
    baseCurrency?: string;
    minified?: boolean;
    timeout?: number;
    headers?: HeadersInit;
}

Hierarchy (view full)

Properties

baseCurrency? minified? timeout? headers? -

Properties

OptionalbaseCurrency

baseCurrency?: string

Optionalminified

minified?: boolean

Optionaltimeout

timeout?: number

Optionalheaders

headers?: HeadersInit

Settings

Member Visibility

On This Page

Properties

Interface HttpRequestOptions

interface HttpRequestOptions {
    timeout?: number;
    headers?: HeadersInit;
}

Hierarchy (view full)

Properties

timeout? +

Interface HttpRequestOptions

interface HttpRequestOptions {
    timeout?: number;
    headers?: HeadersInit;
}

Hierarchy (view full)

Properties

timeout? headers? -

Properties

Optionaltimeout

timeout?: number

Optionalheaders

headers?: HeadersInit

Settings

Member Visibility

On This Page

Properties

Interface HttpResponse<T>

interface HttpResponse<T> {
    code: number;
    message: string;
    data?: T;
}

Type Parameters

  • T

Properties

code +

Interface HttpResponse<T>

interface HttpResponse<T> {
    code: number;
    message: string;
    data?: T;
}

Type Parameters

  • T

Properties

code message data? -

Properties

code

code: number

message

message: string

Optionaldata

data?: T

Settings

Member Visibility

On This Page

Properties

Module index

Index

Modules

<internal> +

Module index

Index

Modules

<internal>

Classes

ForexClient

Interfaces

ForexClientOptions AvailableCurrency diff --git a/docs/types/index.OriginalExchangeRates.html b/docs/types/index.OriginalExchangeRates.html index 70080b8..563b57e 100644 --- a/docs/types/index.OriginalExchangeRates.html +++ b/docs/types/index.OriginalExchangeRates.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #ece7eb; --md-sys-color-surface-container-highest: #e6e1e6 } -

Type Alias OriginalExchangeRates

OriginalExchangeRates: {
    [key: string]: Record<string, number>;
} & {
    date: string;
}

Settings

Member Visibility

Type Alias OriginalExchangeRates

OriginalExchangeRates: {
    [key: string]: Record<string, number>;
} & {
    date: string;
}

Settings

Member Visibility