Add: field arguments to state and country

README.md

@@ -157,12 +157,15 @@ type: **json | ICountry**
 }
 ```
 
-State.getStatesOfCountry(countryCode)
+State.getStatesOfCountry(countryCode, fields)
 ---------------
 
-It accepts a valid `CountryCode` and returns *all States* as Array of JSON
+It accepts a valid 
+`CountryCode` and returns *all States* as Array of JSON, optionally accepts `fields` and returns *all States but with only specified fields* as Array of JSON
 
-type: **array of json | IState**
+type: **array of json | IState[]**
+
+State.getStatesOfCountry("IN")
 
 ```js
 [
@@ -176,12 +179,30 @@ type: **array of json | IState**
 ]
 
 ```
+
+type: **array of json | Partial\<IState>[]**
+
+State.getStatesOfCountry("IN",["name","isoCode"])
+
+```js
+[
+	{
+		"name": "Delhi",
+		"isoCode": "DL",
+	}
+]
+
+```
+
+
+
+
 City.getCitiesOfState(countryCode, stateCode)
 ---------------
 
 It accepts a valid `CountryCode`, `StateCode` and returns *all Cities* as Array of JSON
 
-type: **array of json | ICity**
+type: **array of json | ICity[]**
 
 ```js
 [
@@ -201,7 +222,7 @@ City.getCitiesOfCountry(countryCode)
 
 It accepts a valid `CountryCode` and returns *all Cities* as Array of JSON
 
-type: **array of json | ICity**
+type: **array of json | ICity[]**
 
 ```js
 [
@@ -216,11 +237,13 @@ type: **array of json | ICity**
 
 ```
 
-Country.getAllCountries
+Country.getAllCountries()
 ---------------
-It returns **all Countries**
+It returns **all Countries** abd optionally accepts fields argument which is (keyof ICountry)[] type
+returns *all Countries but with only specified fields*
 
-type: **array of json | ICountry**
+
+type: **array of json | ICountry[]**
 
 ```js
 [
@@ -245,6 +268,23 @@ type: **array of json | ICountry**
 ]
 ```
 
+Country.getAllCountries(["isoCode","name","phonecode"])
+---------------
+type: **array of json | ICountry**
+
+```js
+[
+	{
+		"isoCode": "IN",
+		"name": "India",
+		"phonecode": "91",
+	}
+]
+```
+
+
+
+
 State.getAllStates
 ---------------
 It returns **all States**

src/__test__/country.test.ts

@@ -221,6 +221,12 @@ const executeAllTests = (Country: any) => {
 			const country: ICountry = Country.getCountryByCode(code);
 			expect(country).toEqual(code);
 		});
+
+		test('Check for Specific Fields For Country', () => {
+			const country: ICountry = Country.getAllCountries(["isoCode"])[0]
+			expect(country).toEqual({ isoCode: "AF" });
+		});
+
 	});
 };
 

src/__test__/state.test.ts

@@ -234,7 +234,16 @@ const executeAllTests = (State: any) => {
 				'Zoundwéogo Province',
 			]);
 		});
+
+		test('Check for Specific Fields For Country', () => {
+			const state: IState= State.getStatesOfCountry("IN",["isoCode"])[0]
+			expect(state).toEqual({ isoCode: "AN" });
+		});
+
+
 	});
+
+
 };
 
 export default executeAllTests;

src/country.ts

@@ -1,6 +1,6 @@
 import countryList from './assets/country.json';
 import { compare, findEntryByCode } from './utils';
-import { ICountry } from './interface';
+import { ICountry, CountryFields } from './interface';
 
 // Get a country by isoCode.
 function getCountryByCode(isoCode: string): ICountry | undefined {
@@ -10,7 +10,17 @@ function getCountryByCode(isoCode: string): ICountry | undefined {
 }
 
 // Get a list of all countries.
-function getAllCountries(): ICountry[] {
+function getAllCountries(fields?: CountryFields[]): ICountry[] | Partial<ICountry>[] {
+  if (fields && fields.length > 0) {
+    return countryList.filter(country => {
+      return fields.every(field => country.hasOwnProperty(field));
+    }).map(country => 
+       Object.fromEntries(
+        Object.entries(country)
+        .filter(([key]) => fields.includes(key as keyof ICountry)) 
+      )
+    );
+  }
 	return countryList;
 }
 

src/interface.ts

@@ -17,6 +17,7 @@ export interface ICountry {
 	getAllCountries?(): ICountry[];
 	getCountryByCode?(): ICountry;
 }
+export type CountryFields = keyof ICountry;
 
 export interface IState {
 	name: string;
@@ -28,6 +29,8 @@ export interface IState {
 	getStateByCodeAndCountry?(): IState;
 	getStateByCode?(): IState;
 }
+export type StateFields = keyof IState;
+
 export interface ICity {
 	name: string;
 	countryCode: string;

src/state.ts

@@ -1,19 +1,28 @@
 import stateList from './assets/state.json';
 import { findEntryByCode, findStateByCodeAndCountryCode, compare } from './utils';
-import { IState } from './interface';
+import { IState,StateFields } from './interface';
 
 // Get a list of all states.
 export function getAllStates(): IState[] {
 	return stateList;
 }
 
 // Get a list of states belonging to a specific country.
-export function getStatesOfCountry(countryCode: string = ''): IState[] {
+export function getStatesOfCountry(countryCode: string = '', fields?:StateFields[]): IState[] | Partial<IState>[] {
 	if (!countryCode) return [];
-	// get data from file or cache
-	const states = stateList.filter((value) => {
-		return value.countryCode === countryCode;
-	});
+	const states = stateList.filter((value) => value.countryCode === countryCode);
+
+  if (fields && fields.length > 0) {
+    return states.filter(state => {
+      return fields.every(field  => state.hasOwnProperty(field));
+    }).map(country => 
+       Object.fromEntries(
+        Object.entries(country)
+        .filter(([key]) => fields.includes(key as keyof IState)) 
+      )
+    );
+  }
+
 	return states.sort(compare);
 }
 
@@ -50,3 +59,4 @@ export default {
 	getStateByCode,
 	sortByIsoCode,
 };
+