listAndCountRegions - Region Module Reference

This documentation provides a reference to the listAndCountRegions method. This belongs to the Region Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

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

Example#

To retrieve a list of regions using their IDs:

Code
1const [regions, count] =2  await regionModuleService.listAndCountRegions({3    id: ["reg_123", "reg_321"],4  })

To specify relations that should be retrieved within the regions:

Code
1const [regions, count] =2  await regionModuleService.listAndCountRegions(3    {4      id: ["reg_123", "reg_321"],5    },6    {7      relations: ["countries"],8    }9  )

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

Code
1const [regions, count] =2await regionModuleService.listAndCountRegions(3  {4    id: ["reg_123", "reg_321"],5  },6  {7    relations: ["countries"],8    take: 20,9    skip: 2,10  }11)

Parameters#

filtersFilterableRegionPropsOptional

The filters to apply on the retrieved regions.

configFindConfig<RegionDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<[RegionDTO[], number]>

The list of regions along with their total count.

Was this page helpful?