listRegions - Region Module Reference

This documentation provides a reference to the listRegions 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 based on optional filters and configuration.

Example#

To retrieve a list of regions using their IDs:

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

To specify relations that should be retrieved within the regions:

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

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 = await regionModuleService.listRegions(2  {3    id: ["reg_123", "reg_321"],4  },5  {6    relations: ["countries"],7    take: 20,8    skip: 2,9  }10)

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[]>

The list of regions.

Was this page helpful?