@aliraslan/fx

---

@aliraslan/fx / react / useCurrency

Function: useCurrency()

useCurrency(options): object

Defined in: src/react/useCurrency.ts:24

Headless hook combining live rate fetching, polling, and natural-language expression evaluation. Wire its returned values into any UI.

Parameters

options

UseCurrencyOptions

Returns

object

addCurrency

addCurrency: (currencyCode, rates) => void

Parameters

currencyCode

string

rates

Rates

Returns

void

baseCurrency

baseCurrency: string

error

error: Error | null

evaluate

evaluate: (expr, overrideCurrency?) => EvaluatedExpression

Parameters

expr

string

overrideCurrency?

string

Returns

EvaluatedExpression

rates

rates: RatesCache

refresh

refresh: (overrideCurrency?) => void

Parameters

overrideCurrency?

string

Returns

void

setBaseCurrency

setBaseCurrency: (currencyCode) => void

Parameters

currencyCode

string

Returns

void