listAndCountTags - Product Module Reference

Beta

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

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

Example

To retrieve a list of product tags using their IDs:

const [tags, count] =
  await productModuleService.listAndCountTags({
    id: ["ptag_123", "ptag_321"],
  })

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

const [tags, count] =
  await productModuleService.listAndCountTags(
    {
      id: ["ptag_123", "ptag_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 [tags, count] =
  await productModuleService.listAndCountTags(
    {
      id: ["ptag_123", "ptag_321"],
    },
    {
      relations: ["products"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterableProductTagProps

The filters applied on the retrieved product tags.

configFindConfig<ProductTagDTO>

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

sharedContextContext

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

Returns

PromisePromise<[ProductTagDTO[], number]>Required

The list of product tags along with the total count.