Socket
Socket
Sign inDemoInstall

city-state-country

Package Overview
Dependencies
88
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

city-state-country

Get cities, states, countries across the world.


Version published
Maintainers
1
Weekly downloads
538
decreased by-11.07%

Weekly downloads

Readme

Source

Cities-States-Country

Get all Cities, State, Country all over the world.

Steps for Installation


Install the package with
  npm i city-state-country --save
  

Usage

  var worldMapData = require('city-state-country');

Supported Methods


Countries Methods


Get list of all Countries

 const countriesList = worldMapData.getAllCountries();

Search Country

The search text field is case insensitive.

 const countriesList = worldMapData.searchCountry('indi');

Search Country by CountryCode (ISO2)

Only ISO2 Country code value is supported.

 const countriesList = worldMapData.searchCountryByCountryCode('IN');

State Methods


Get list of all States by a Country Name

The search text field is case insensitive.

 const statesList = worldMapData.getAllStatesFromCountry('India');

Get list of all States by Country Id

Use Country Id from country data.

 const statesList = worldMapData.getStatesByCountryId('101');

Search State details

This method will return all states from world which starts with 'maha'. The search text field is case insensitive.

 const statesList = worldMapData.searchState('maha');
 

City Methods


Get list of all Cities by State Name

The search text field is case sensitive.

 const citiesList = worldMapData.getAllCitiesFromState('Maharashtra');

Get list of all Cities by State Id

Use State Id from state data.

 const citiesList = worldMapData.getAllCitiesByStateId('4008');

Search City details

This method will return all cities from world which starts with 'parbh'.

 const citiesList = worldMapData.searchCity('parbh');

Submit Issues

Email me regarding any issue me at swapnil.nakhate1010@gmail.com


Note

Database used for this plugin is updated. This database is taken from : https://github.com/dr5hn/countries-states-cities-database.

License

This Countries States Cities Database is made available under the Open Database License. Any rights in individual contents of the database are licensed under the Database Contents License.

Keywords

FAQs

Last updated on 21 Feb 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc