Skip to content

hmvmpire/country-state-city

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

country-state-city

Basic library for Country, State and City

Data taken from:

https://github.com/hiiamrohit/Countries-States-Cities-database

Install

npm i country-state-city

Docs

getCountryById(id)

It accepts a valid CountryId and returns Country Details

type: json

{
	"id": "4",
	"sortname": "AS",
	"name": "American Samoa",
	"phonecode": "1684"
}

getStateById(id)

It accepts a valid StateId and returns State Details

type: json

{
	"id": 4119,
	"name": "Midlands",
	"country_id": "246"
}

getCityById(id)

It accepts a valid CityId and returns City Details

type: json

{
	"id": "3",
	"name": "Port Blair",
	"state_id": "1"
}

getStatesOfCountry(countryId)

It accepts a valid CountryId and returns all States as Array of JSON

type: array of json

[
  {
    "id": 4119,
    "name": "Midlands",
    "country_id": "246"
  }
]

getCitiesOfState(stateId)

It accepts a valid CityId and returns all Cities as Array of JSON

type: array of json

[
  {
    "id": "3",
    "name": "Port Blair",
    "state_id": "1"
  }
]

getAllCountries

It returns all Countries

type: array of json

[
  {
    "id": "4",
    "sortname": "AS",
    "name": "American Samoa",
    "phonecode": "1684"
  }
]

Change Logs

V0.1.0

  1. Fix: #2
  2. Fix: #3
  3. Added some missing states and cities for Canada and US

About

Basic library for Country, State and City

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%