listCountries - Region Module Reference

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

Example#

To retrieve a list of countries using their IDs:

Code
1const countries = await regionModuleService.listCountries({2  iso_2: ["us", "eur"],3})

To specify relations that should be retrieved within the countries:

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const countries = await regionModuleService.listCountries(2  {3    iso_2: ["us", "eur"],4  },5  {6    relations: ["region"],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 countries = await regionModuleService.listCountries(2  {3    iso_2: ["us", "eur"],4  },5  {6    relations: ["region"],7    take: 20,8    skip: 2,9  }10)

Parameters#

filtersFilterableRegionCountryPropsOptional

The filters to apply on the retrieved countries.

configFindConfig<RegionCountryDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<RegionCountryDTO[]>

The list of countries.