Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

listCurrencies - Currency Module Reference

This documentation provides a reference to the listCurrencies 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 is used to retrieve a paginated list of currencies based on optional filters and configuration.

Example#

To retrieve a list of currencies using their codes:

Code
1const currencies = await currencyModuleService.listCurrencies({2  code: ["usd", "eur"],3})

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

Code
1const currencies = await currencyModuleService.listCurrencies(2  {3    code: ["usd", "eur"],4  },5  {6    take: 20,7    skip: 2,8  }9)

Parameters#

filtersFilterableCurrencyPropsOptional
The filters to apply on the retrieved currencies.
configFindConfig<CurrencyDTO>Optional
The configurations determining how the currencies are 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 list of currencies.
Was this page helpful?