listAndCountCategories - Product Module Reference

Beta

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

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

Example

To retrieve a list of product categories using their IDs:

const [categories, count] =
  await productModuleService.listAndCountCategories({
    id: ["pcat_123", "pcat_321"],
  })

To specify relations that should be retrieved within the product categories:

const [categories, count] =
  await productModuleService.listAndCountCategories(
    {
      id: ["pcat_123", "pcat_321"],
    },
    {
      relations: ["products"],
    }
  )

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

Parameters

filtersFilterableProductCategoryProps

The filters to apply on the retrieved product categories.

configFindConfig<ProductCategoryDTO>

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

sharedContextContext

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

Returns

PromisePromise<[ProductCategoryDTO[], number]>Required

The list of product categories along with their total count.