retrieveCurrency - Currency Module Reference

This documentation provides a reference to the retrieveCurrency method. This belongs to the Currency Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method retrieves a currency by its code and and optionally based on the provided configurations.

Example#

Code
const currency = await currencyModuleService.retrieveCurrency("usd")

Parameters#

codestring

The code of the currency to retrieve.

configFindConfig<CurrencyDTO>Optional

The configurations determining how the currency is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a currency.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<CurrencyDTO>

The retrieved currency.