listCountries - Region Module Reference

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

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

Example

To retrieve a list of countries using their IDs:

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

To specify relations that should be retrieved within the countries:

const countries = await regionModuleService.listCountries(
  {
    iso_2: ["us", "eur"],
  },
  {
    relations: ["region"],
  }
)

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 countries = await regionModuleService.listCountries(
  {
    iso_2: ["us", "eur"],
  },
  {
    relations: ["region"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableRegionCountryProps

The filters to apply on the retrieved countries.

configFindConfig<RegionCountryDTO>

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

sharedContextContext

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

Returns

PromisePromise<RegionCountryDTO[]>Required

The list of countries.