API ReferenceReactInterfaces
Interface: UseCurrencyOptions
@aliraslan/fx / react / UseCurrencyOptions
Interface: UseCurrencyOptions
Defined in: src/react/useCurrency.ts:10
Options for useCurrency.
Properties
endpoint
endpoint:
string
Defined in: src/react/useCurrency.ts:12
The rate-provider endpoint to pass to fetchExchangeRates — required, fx has no built-in provider.
pollIntervalMs?
optionalpollIntervalMs?:number
Defined in: src/react/useCurrency.ts:16
How often to auto-refresh rates for the current base currency, in milliseconds. Defaults to 5 minutes.
store?
optionalstore?:UseBoundStore<WithImmer<Write<StoreApi<CurrenciesState>,StorePersist<CurrenciesState,unknown>>>>
Defined in: src/react/useCurrency.ts:14
A store from createCurrenciesStore — defaults to a module-level shared store. Pass your own for multiple independent instances or custom persistence.