country-state-city

Basic library for Country, State and City

Data taken from:

Install

npm i country-state-city

Usage

Latest Release : v1.0.0 (First Major Version Release - Not backward compatible)

• ES6 Module usage

  1import csc from 'country-state-city'
  2
  3// Import Interfaces`
  4import { ICountry, IState, ICity } from 'country-state-city'

• AMD Module usage

  1let csc = require('country-state-city').default

For versions v0.1.8 and below

• ES6 Module usage

  1import csc from 'country-state-city'

• AMD Module usage

  1let csc = require('country-state-city')

Docs

getCountryByCode(code)

It accepts a valid CountryCode eg: 'AS' and returns Country Details

type: json | ICountry

1{
2	"id": "4",
3	"sortname": "AS",
4	"name": "American Samoa",
5	"phonecode": "1684"
6}

getCountryById(id)

It accepts a valid CountryId and returns Country Details

type: json | ICountry

1{
2	"id": "4",
3	"sortname": "AS",
4	"name": "American Samoa",
5	"phonecode": "1684"
6}

getStateById(id)

It accepts a valid StateId and returns State Details

type: json | IState

1{
2	"id": 4119,
3	"name": "Midlands",
4	"country_id": "246"
5}

getCityById(id)

It accepts a valid CityId and returns City Details

type: json | ICity

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

getStatesOfCountry(countryId)

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

type: array of json | IState

1[
2  {
3    "id": 4119,
4    "name": "Midlands",
5    "country_id": "246"
6  }
7]
8

getCitiesOfState(stateId)

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

type: array of json | ICity

1[
2  {
3    "id": "3",
4    "name": "Port Blair",
5    "state_id": "1"
6  }
7]
8

getAllCountries

It returns all Countries

type: array of json | ICountry

1[
2  {
3    "id": "4",
4    "sortname": "AS",
5    "name": "American Samoa",
6    "phonecode": "1684"
7  }
8]