Country States Cities Module

This package provides a list of all the countries, their states, and cities, and various relevant information pertaining to them.

Installation

Use the package manager npm or yarn.

1npm install country-state-cities-module

Usage

1import {
2  getAllCountries,
3  getStatesByCountry,
4  getCitiesByStateAndCountry,
5} from "country-state-cities-module";
6
7const testFunction = async () => {
8  // returns list of all the countries in the world
9  await getAllCountries()
10    .then(data => {
11      console.log(data);
12    })
13    .catch(e => {
14      console.log(e);
15    });
16
17  // returns the list of states in the country passed as an argument
18  // Also note that for countries having spaces in their name, do not omit spaces.
19
20  await getStatesByCountry("United States")
21    .then(data => {
22      console.log(data);
23    })
24    .catch(e => {
25      console.log(e);
26    });
27
28  // return the list of cities for the provided pair of Country and States
29  await getCitiesByStateAndCountry("United States", "Alabama")
30    .then(data => {
31      console.log(data);
32    })
33    .catch(e => {
34      console.log(e);
35    });
36
37  // return a detailed information about the provided Country
38  await getCountry("India")
39    .then(data => {
40      console.log(data);
41    })
42    .catch(e => {
43      console.log(e);
44    });
45};
46
47testFunction();

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Github: https://github.com/brigadierpratap/country-states-cities-module

Buy me a coffee

License

ISC