listAndCount - Product Module Reference

Beta

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

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

Example

To retrieve a list of products using their IDs:

const [products, count] =
  await productModuleService.listAndCount({
    id: ["prod_123", "prod_321"],
  })

To specify relations that should be retrieved within the products:

const [products, count] =
  await productModuleService.listAndCount(
    {
      id: ["prod_123", "prod_321"],
    },
    {
      relations: ["categories"],
    }
  )

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 [products, count] =
  await productModuleService.listAndCount(
    {
      id: ["prod_123", "prod_321"],
    },
    {
      relations: ["categories"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterableProductProps

The filters to apply on the retrieved products.

configFindConfig<ProductDTO>

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

sharedContextContext

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

Returns

PromisePromise<[ProductDTO[], number]>Required

The list of products along with the total count.