country-state-city-usa

Basic library for Country, State and City

Library is forked from https://www.npmjs.com/package/country-state-city. This version of library is updated for United state.

Install

npm i country-state-city-usa

yarn add country-state-city-usa --dev

Usage

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

• ES6 Module usage

  import csc from 'country-state-city-usa'
  
  // Import Interfaces`
  import { ICountry, IState, ICity } from 'country-state-city-usa'

• AMD Module usage

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

For versions v0.1.8 and below

• ES6 Module usage

  import csc from 'country-state-city-usa'

• AMD Module usage

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

Docs

getCountryByCode(code)

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

type: json | ICountry

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

getCountryById(id)

It accepts a valid CountryId and returns Country Details

type: json | ICountry

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

getStateById(id)

It accepts a valid StateId and returns State Details

type: json | IState

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

getCityById(id)

It accepts a valid CityId and returns City Details

type: json | ICity

{
	"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 | IState

[
  {
    "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 | ICity

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

getAllCountries

It returns all Countries

type: array of json | ICountry

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

Special Thanks

@baywet - For mentoring Javascript to Typescript Conversion

Change Logs

v1.0.0

1. export = {} changed to export default in index.ts.
2. Interface type re-exported from index.ts.
3. Compatible with ES6 module syntax.
4. Compatible with AMD module - using require('../index').default.
5. Add tests for Interface Re-Exports.
6. Test cases for both AMD modules and ES6 modules usage.
7. Common Test Cases are being shared between AMD and ES6 modules test files.

v0.1.8

1. Development code - Javascript to Typescript conversion: #12

v0.1.0

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