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
v1.0.0
(First Major Version Release - Not backward compatible)
Latest Release : -
ES6 Module usage
// Import Interfaces` -
AMD Module usage
let csc = default
v0.1.8 and below
For versions -
ES6 Module usage
-
AMD Module usage
let csc =
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
export = {}
changed toexport default
in index.ts.Interface
typere-exported
fromindex.ts
.Compatible
withES6
module syntax.Compatible
withAMD
module - usingrequire('../index').default
.- Add tests for Interface Re-Exports.
- Test cases for both AMD modules and ES6 modules usage.
- Common Test Cases are being shared between AMD and ES6 modules test files.
v0.1.8
- Development code - Javascript to Typescript conversion: #12
v0.1.0