listAndCountCountries - Region Module Reference

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

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

Example

To retrieve a list of countries using their IDs:

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

To specify relations that should be retrieved within the countries:

const [countries, count] =
  await regionModuleService.listAndCountCountries(
    {
      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, count] =
  await regionModuleService.listAndCountCountries(
    {
      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[], number]>Required

The list of countries along with their total count.