list - Region Module Reference

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

This method retrieves a paginated list of regions based on optional filters and configuration.

Example

To retrieve a list of regions using their IDs:

const regions = await regionModuleService.list({
  id: ["reg_123", "reg_321"],
})

To specify relations that should be retrieved within the regions:

const regions = await regionModuleService.list(
  {
    id: ["reg_123", "reg_321"],
  },
  {
    relations: ["countries"],
  }
)

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 regions = await regionModuleService.list(
  {
    id: ["reg_123", "reg_321"],
  },
  {
    relations: ["countries"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableRegionProps

The filters to apply on the retrieved regions.

configFindConfig<RegionDTO>

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

sharedContextContext

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

Returns

PromisePromise<RegionDTO[]>Required

The list of regions.