country-state-city - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

index.js

@@ -36,3 +36,3 @@ var countryList = require("./lib/country.json")
 	},
-	getAllCountries: function(stateId) {
+	getAllCountries: function() {
 		return countryList;
@@ -39,0 +39,0 @@ }

package.json

 {
   "name": "country-state-city",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Library for fetching Country, its States and Cities",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,2 +0,107 @@
-# country-state-city
+country-state-city
+==============================
 Basic library for Country, State and City
+
+Data taken from:
+
+https://github.com/hiiamrohit/Countries-States-Cities-database
+
+# Docs
+
+getCountryById(id)
+---------------
+
+It accepts a valid `CountryId` and   returns *Country Details*
+
+type: *json*
+
+```js
+{
+	"id": "4",
+	"sortname": "AS",
+	"name": "American Samoa",
+	"phonecode": "1684"
+}
+```
+
+getStateById(id)
+---------------
+
+It accepts a valid `StateId` and   returns *State Details*
+
+type: *json*
+
+```js
+{
+	"id": 4119,
+	"name": "Midlands",
+	"country_id": "246"
+}
+```
+
+getCityById(id)
+---------------
+
+It accepts a valid `CityId` and   returns *City Details*
+
+type: *json*
+
+```js
+{
+	"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*
+
+```js
+[
+  {
+    "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*
+
+```js
+[
+  {
+    "id": "3",
+    "name": "Port Blair",
+    "state_id": "1"
+  }
+]
+
+```
+
+getAllCountries
+---------------
+It returns *all Countries*
+
+type: *array of json*
+
+```js
+[
+  {
+    "id": "4",
+    "sortname": "AS",
+    "name": "American Samoa",
+    "phonecode": "1684"
+  }
+]
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3316403

increased by0.03%

Number of package files

8

increased by14.29%

Lines of code

211001

Number of lines in readme file

108

increased by3500%

No dependency changes