listAndCount - Promotion Module Reference

This documentation provides a reference to the listAndCount method. This belongs to the Promotion Module.

This method retrieves a paginated list of promotions along with the total count of available promotions satisfying the provided filters.

Example

To retrieve a list of promotions using their IDs:

const [promotions, count] =
  await promotionModuleService.listAndCount({
    id: ["promo_123", "promo_321"],
  })

To specify relations that should be retrieved within the promotions:

const [promotions, count] =
  await promotionModuleService.listAndCount(
    {
      id: ["promo_123", "promo_321"],
    },
    {
      relations: ["application_method"],
    }
  )

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 [promotions, count] =
  await promotionModuleService.listAndCount(
    {
      id: ["promo_123", "promo_321"],
    },
    {
      relations: ["application_method"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterablePromotionProps

The filters to apply on the retrieved promotions.

configFindConfig<PromotionDTO>

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

sharedContextContext

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

Returns

PromisePromise<[PromotionDTO[], number]>Required

The list of promotions along with their total count.