list - Currency Module Reference

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

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:

const currencies = await currencyModuleService.list({
  code: ["usd", "eur"],
})

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

const currencies = await currencyModuleService.list(
  {
    code: ["usd", "eur"],
  },
  {
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableCurrencyProps

The filters to apply on the retrieved currencies.

configFindConfig<CurrencyDTO>

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

sharedContextContext

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

Returns

PromisePromise<CurrencyDTO[]>Required

The list of currencies.