JSPM

  • Created
  • Published
  • Downloads 121059
  • Score
    100M100P100Q169495F
  • License GPL-3.0

Library for fetching Country, its States and Cities

Package Exports

  • country-state-city

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 (country-state-city) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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