ICurrencyModuleService

The main service interface for the Currency Module.

Methods

retrieve

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

Example

const currency = await currencyModuleService.retrieve("usd")

Parameters

codestringRequired

The code of the currency to retrieve.

configFindConfig<CurrencyDTO>

The configurations determining how the currency is 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 retrieved currency.

list

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.

listAndCount

This method is used to retrieve a paginated list of currencies along with the total count of available currencies satisfying the provided filters.

Example

To retrieve a list of currencies using their codes:

const [currencies, count] =
  await currencyModuleService.listAndCount({
    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, count] =
  await currencyModuleService.listAndCount(
    {
      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[], number]>Required

The list of currencies along with the total count.