Package Exports
- countries-with-cities-select
- countries-with-cities-select/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (countries-with-cities-select) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
countries-with-cities-select
Retrieve all countries with cities
Table of Contents
Features
- Get names, codes and cities of all countries
- Filter cities by country name, country code, continent name
Installing
npm install countries-with-cities-select
OR
yarn add countries-with-cities-select
Once the package is installed you use the require/import approach
const countriesWithCities = require('countries-with-cities-select');
OR
import countriesWithCities from 'countries-with-cities-select'
Or with TypeScript
import * as countriesWithCities from 'countries-with-cities-select'create a .d.ts file and add
declare module 'countries-with-cities-select'#Get countries
This will list all countries.
const countriesWithCities = require('countries-with-cities-select');
// To get all countries
countriesWithCities.getCountries();
#Get countries with details
This will retrieve information about countries with code, continent etc. Filter by country name, country code or continent
const countriesWithCities = require('countries-with-cities-select');
countriesWithCities.getCountriesWithDetails();
// To get the countries with code, name or continent name
countriesWithCities.getCountriesWithDetails("kenya");
// use exact code to filter country with code
countriesWithCities.getCountriesWithDetails("KE");
countriesWithCities.getCountriesWithDetails("africa");
#Get cities
This will retrieve information about cities. Filter with country name, country code or continent Empty filter will return no cities
const countriesWithCities = require('countries-with-cities-select');
// To get all cities in a country
countriesWithCities.getCities('kenya');
// To get all cities in a continent
countriesWithCities.getCities('africa');
// To get all cities in a country with code
countriesWithCities.getCities('ke');
// To getcity with name
countriesWithCities.getCities('nairobi');
License
Happy coding, Star before Fork 😊💪💯