country-data-filter 1.0.16 → 1.0.17

package/README.md

@@ -14,82 +14,129 @@ In your JavaScript or TypeScript project, you can import the functions provided
 JavaScript
 javascript
 Copy code
-const { 
-  getProvincesDistrictsCitiesByCountryFunction, 
-  getCountryProvinceCityByDistrict, 
-  getCountryDistrictsCitiesByProvince, 
-  listFunctions 
-} = require('country-data-filter');
+
+````js
+const {
+    getDataByCountry,
+    getDataByProvince,
+    getDataByDistrict,
+    getDataByCity,
+    getDataByCountryProvince,
+    getDataByCountryProvinceDistrict,
+    getDataByCountryProvinceDistrictCity,
+    getDataByEtherCountryProvinceDistrictCity,
+    getDataByCountryDistrict,
+    getDataByCountryCity,
+    getDataByProvinceDistrict,
+    getDataByProvinceCity,
+    getDataByDistrictCity,
+    getCurrencyByCountry,
+    getDataByPostalCode,
+    listFunctions,
+} = require('country-data-filter');```
+
 TypeScript
 typescript
 Copy code
-import { 
-  getProvincesDistrictsCitiesByCountryFunction, 
-  getCountryProvinceCityByDistrict, 
-  getCountryDistrictsCitiesByProvince, 
-  listFunctions 
-} from 'country-data-filter';
-Functions
-getProvincesDistrictsCitiesByCountryFunction(code)
+`import {
+    getDataByCountry,
+    getDataByProvince,
+    getDataByDistrict,
+    getDataByCity,
+    getDataByCountryProvince,
+    getDataByCountryProvinceDistrict,
+    getDataByCountryProvinceDistrictCity,
+    getDataByEtherCountryProvinceDistrictCity,
+    getDataByCountryDistrict,
+    getDataByCountryCity,
+    getDataByProvinceDistrict,
+    getDataByProvinceCity,
+    getDataByDistrictCity,
+    getCurrencyByCountry,
+    getDataByPostalCode,
+    listFunctions,
+} from 'country-data-filter';`
+
+javascript
+Copy code
+`const result = getDataByCountry(countryCode);
+console.log(result);`
 Returns a list of provinces, districts, and cities for a given country code.
 
 Parameters:
-
 code (string): The country code (e.g., 'LK' for Sri Lanka).
-Returns:
 
+Returns:
 An object containing sorted arrays of provinces, districts, and cities, or an error message if the country code is invalid.
-Example:
 
 javascript
 Copy code
-const result = getProvincesDistrictsCitiesByCountryFunction('LK');
-console.log(result);
-getCountryProvinceCityByDistrict(districtName)
+`const result = getDataByDistrict(districtName);
+console.log(result);`
 Returns the country code, province, and cities for a given district name.
 
 Parameters:
-
 districtName (string): The name of the district.
-Returns:
 
+Returns:
 An object containing the country code, province name, and list of cities, or an error message if the district name is invalid.
-Example:
 
 javascript
 Copy code
-const result = getCountryProvinceCityByDistrict('Matara');
-console.log(result);
-getCountryDistrictsCitiesByProvince(provinceName)
+`const result = getDataByProvince(provinceName);
+console.log(result);`
 Returns the list of districts and cities for a given province name.
 
 Parameters:
-
 provinceName (string): The name of the province.
-Returns:
 
+Returns:
 An object containing the list of districts and cities, or an error message if the province name is invalid.
-Example:
 
 javascript
 Copy code
-const result = getCountryDistrictsCitiesByProvince('Southern');
-console.log(result);
-listFunctions()
+`const result = listFunctions()
+console.log(result)`
 Returns a list of all available functions in the package.
 
 Returns:
-
-An object containing the function names and their references.
-Example:
+An object containing the filtered data list.
 
 javascript
 Copy code
-const functions = listFunctions();
-console.log(functions);
+`const result = getDataByEtherCountryProvinceDistrictCity();
+console.log(result);`
+
+Parameters:
+countryCode (string)?: The code of the country.
+provinceName (string)?: The name of the province.
+districtName (string)?: The name of the district.
+cityName (string)?: The name of the city.
+
 Data Structure
 The data for countries, provinces, districts, and cities is stored in JavaScript objects. Each country object contains provinces, and each province object contains districts and cities.
 
+list of functions
+
+javascript
+Copy code
+` getDataByCountry(countryCode); // countryCode: string
+    getDataByProvince(provinceName); // provinceName: string
+    getDataByDistrict(districtName);  // districtName: string
+    getDataByCity(cityName); // cityName: string
+    getDataByCountryProvince(countryCode, provinceName); // countryCode: string, provinceName: string
+    getDataByCountryProvinceDistrict(countryCode, provinceName, districtName); // countryCode: string, provinceName: string, districtName: string
+    getDataByCountryProvinceDistrictCity(countryCode, provinceName, districtName, cityName); // countryCode: string, provinceName: string, districtName: string, cityName: string
+    getDataByEtherCountryProvinceDistrictCity(countryCode, provinceName, districtName, cityName); // countryCode: string, provinceName: string, districtName: string, cityName: string
+    getDataByCountryDistrict(countryCode, districtName); // countryCode: string, districtName: string
+    getDataByCountryCity(countryCode, cityName); // countryCode: string, cityName: string
+    getDataByProvinceDistrict(provinceName, districtName); // provinceName: string districtName: string
+    getDataByProvinceCity(provinceName, cityName); // provinceName: string, cityName: string
+    getDataByDistrictCity(districtName, cityName); // districtName: string, cityName: string
+    getCurrencyByCountry(countryCode); // countryCode: string
+    getDataByPostalCode(postalCode); // postalCode: string 
+    `
+
 Contributing
 If you want to contribute to this project, please follow these steps:
 
@@ -103,3 +150,4 @@ This project is licensed under the MIT License. See the LICENSE file for details
 Contact
 For any questions or support, please contact knnadeera1@gmail.com.
 
+````

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "country-data-filter",
-  "version": "1.0.16",
+  "version": "1.0.17",
   "description": "A package to filter country data",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/countries/LK/LK.js

@@ -27,6 +27,7 @@ import { vavuniya } from "./districts/vavuniya";
 export const LK = {
   name: "Sri Lanka",
   code: "LK",
+  currency: "LKR",
   countryCode: "+94",
   provinces: {
     southern: {

package/src/countries/US/US.js

@@ -0,0 +1,150 @@
+import { alabama } from "./district/alabama";
+import { alaska } from "./district/alaska";
+import { arizona } from "./district/arizona";
+import { arkansas } from "./district/arkansas";
+import { california } from "./district/california";
+import { colorado } from "./district/colorado";
+import { connecticut } from "./district/connecticut";
+import { delaware } from "./district/delaware";
+import { florida } from "./district/florida";
+
+export const US = {
+  name: "United States of America",
+  code: "US",
+  currency: "USD",
+  countryCode: "+1",
+  provinces: {
+    alabama,
+    alaska,
+    arizona,
+    arkansas,
+    california,
+    colorado,
+    connecticut,
+    delaware,
+    florida,
+    georgia: {
+      name: "Georgia",
+    },
+    hawaii: {
+      name: "Hawaii",
+    },
+    idaho: {
+      name: "Idaho",
+    },
+    illinois: {
+      name: "Illinois",
+    },
+    indiana: {
+      name: "Indiana",
+    },
+    iowa: {
+      name: "Iowa",
+    },
+    kansas: {
+      name: "Kansas",
+    },
+    kentucky: {
+      name: "Kentucky",
+    },
+    louisiana: {
+      name: "Louisiana",
+    },
+    maine: {
+      name: "Maine",
+    },
+    maryland: {
+      name: "Maryland",
+    },
+    massachusetts: {
+      name: "Massachusetts",
+    },
+    michigan: {
+      name: "Michigan",
+    },
+    minnesota: {
+      name: "Minnesota",
+    },
+    mississippi: {
+      name: "Mississippi",
+    },
+    missouri: {
+      name: "Missouri",
+    },
+    montana: {
+      name: "Montana",
+    },
+    nebraska: {
+      name: "Nebraska",
+    },
+    nevada: {
+      name: "Nevada",
+    },
+    newHampshire: {
+      name: "New Hampshire",
+    },
+    newJersey: {
+      name: "New Jersey",
+    },
+    newMexico: {
+      name: "New Mexico",
+    },
+    newYork: {
+      name: "New York",
+    },
+    northCarolina: {
+      name: "North Carolina",
+    },
+    northDakota: {
+      name: "North Dakota",
+    },
+    ohio: {
+      name: "Ohio",
+    },
+    oklahoma: {
+      name: "Oklahoma",
+    },
+    oregon: {
+      name: "Oregon",
+    },
+    pennsylvania: {
+      name: "Pennsylvania",
+    },
+    rhodeIsland: {
+      name: "Rhode Island",
+    },
+    southCarolina: {
+      name: "South Carolina",
+    },
+    southDakota: {
+      name: "South Dakota",
+    },
+    tennessee: {
+      name: "Tennessee",
+    },
+    texas: {
+      name: "Texas",
+    },
+    utah: {
+      name: "Utah",
+    },
+    vermont: {
+      name: "Vermont",
+    },
+    virginia: {
+      name: "Virginia",
+    },
+    washington: {
+      name: "Washington",
+    },
+    westVirginia: {
+      name: "West Virginia",
+    },
+    wisconsin: {
+      name: "Wisconsin",
+    },
+    wyoming: {
+      name: "Wyoming",
+    },
+  },
+};

package/src/countries/US/district/alabama.js

@@ -0,0 +1,80 @@
+export const alabama = {
+  name: "Alabama",
+  cities: [
+    { name: "Birmingham", postalCode: "35233" },
+    { name: "Montgomery", postalCode: "36104" },
+    { name: "Mobile", postalCode: "36602" },
+    { name: "Huntsville", postalCode: "35801" },
+    { name: "Tuscaloosa", postalCode: "35487" },
+    { name: "Hoover", postalCode: "35244" },
+    { name: "Auburn", postalCode: "36830" },
+    { name: "Dothan", postalCode: "36301" },
+    { name: "Decatur", postalCode: "35601" },
+    { name: "Madison", postalCode: "35758" },
+    { name: "Florence", postalCode: "35630" },
+    { name: "Gadsden", postalCode: "35901" },
+    { name: "Vestavia Hills", postalCode: "35216" },
+    { name: "Prattville", postalCode: "36066" },
+    { name: "Phenix City", postalCode: "36867" },
+    { name: "Alabaster", postalCode: "35007" },
+    { name: "Bessemer", postalCode: "35020" },
+    { name: "Enterprise", postalCode: "36330" },
+    { name: "Opelika", postalCode: "36801" },
+    { name: "Homewood", postalCode: "35209" },
+    { name: "Northport", postalCode: "35473" },
+    { name: "Anniston", postalCode: "36201" },
+    { name: "Prichard", postalCode: "36610" },
+    { name: "Athens", postalCode: "35611" },
+    { name: "Daphne", postalCode: "36526" },
+    { name: "Pelham", postalCode: "35124" },
+    { name: "Oxford", postalCode: "36203" },
+    { name: "Albertville", postalCode: "35950" },
+    { name: "Selma", postalCode: "36701" },
+    { name: "Mountain Brook", postalCode: "35223" },
+    { name: "Trussville", postalCode: "35173" },
+    { name: "Troy", postalCode: "36081" },
+    { name: "Center Point", postalCode: "35215" },
+    { name: "Foley", postalCode: "36535" },
+    { name: "Alexander City", postalCode: "35010" },
+    { name: "Gardendale", postalCode: "35071" },
+    { name: "Fairhope", postalCode: "36532" },
+    { name: "Cullman", postalCode: "35055" },
+    { name: "Hueytown", postalCode: "35023" },
+    { name: "Fort Payne", postalCode: "35967" },
+    { name: "Ozark", postalCode: "36360" },
+    { name: "Scottsboro", postalCode: "35768" },
+    { name: "Eufaula", postalCode: "36027" },
+    { name: "Chelsea", postalCode: "35043" },
+    { name: "Talladega", postalCode: "35160" },
+    { name: "Sylacauga", postalCode: "35150" },
+    { name: "Clanton", postalCode: "35045" },
+    { name: "Millbrook", postalCode: "36054" },
+    { name: "Hartselle", postalCode: "35640" },
+    { name: "Pell City", postalCode: "35125" },
+    { name: "Saraland", postalCode: "36571" },
+    { name: "Calera", postalCode: "35040" },
+    { name: "Muscle Shoals", postalCode: "35661" },
+    { name: "Jasper", postalCode: "35501" },
+    { name: "Fairfield", postalCode: "35064" },
+    { name: "Jacksonville", postalCode: "36265" },
+    { name: "Spanish Fort", postalCode: "36527" },
+    { name: "Tallassee", postalCode: "36078" },
+    { name: "Fultondale", postalCode: "35068" },
+    { name: "Heflin", postalCode: "36264" },
+    { name: "Irondale", postalCode: "35210" },
+    { name: "Satsuma", postalCode: "36572" },
+    { name: "Gulf Shores", postalCode: "36542" },
+    { name: "Oneonta", postalCode: "35121" },
+    { name: "Valley", postalCode: "36854" },
+    { name: "Odenville", postalCode: "35120" },
+    { name: "Clay", postalCode: "35048" },
+    { name: "Moody", postalCode: "35004" },
+    { name: "Hamilton", postalCode: "35570" },
+    { name: "Demopolis", postalCode: "36732" },
+    { name: "Grayson Valley", postalCode: "35235" },
+    { name: "Rainsville", postalCode: "35986" },
+    { name: "Childersburg", postalCode: "35044" },
+    { name: "Pike Road", postalCode: "36064" },
+    { name: "Gulf Shores", postalCode: "36542" },
+  ],
+};

package/src/countries/US/district/alaska.js

@@ -0,0 +1,25 @@
+export const alaska = {
+  name: "alaska",
+  cities: [
+    { name: "Anchorage", postalCode: "99501" },
+    { name: "Fairbanks", postalCode: "99701" },
+    { name: "Juneau", postalCode: "99801" },
+    { name: "Sitka", postalCode: "99835" },
+    { name: "Ketchikan", postalCode: "99901" },
+    { name: "Wasilla", postalCode: "99654" },
+    { name: "Kenai", postalCode: "99611" },
+    { name: "Kodiak", postalCode: "99615" },
+    { name: "Bethel", postalCode: "99559" },
+    { name: "Palmer", postalCode: "99645" },
+    { name: "Homer", postalCode: "99603" },
+    { name: "Nome", postalCode: "99762" },
+    { name: "Valdez", postalCode: "99686" },
+    { name: "Barrow", postalCode: "99723" },
+    { name: "Soldotna", postalCode: "99669" },
+    { name: "Kotzebue", postalCode: "99752" },
+    { name: "Seward", postalCode: "99664" },
+    { name: "Dillingham", postalCode: "99576" },
+    { name: "Cordova", postalCode: "99574" },
+    { name: "Wrangell", postalCode: "99929" },
+  ],
+};

package/src/countries/US/district/arizona.js

@@ -0,0 +1,35 @@
+export const arizona = {
+  name: "arizona",
+  cities: [
+    { name: "Phoenix", postalCode: "85001" },
+    { name: "Tucson", postalCode: "85701" },
+    { name: "Mesa", postalCode: "85201" },
+    { name: "Chandler", postalCode: "85224" },
+    { name: "Glendale", postalCode: "85301" },
+    { name: "Scottsdale", postalCode: "85250" },
+    { name: "Gilbert", postalCode: "85233" },
+    { name: "Tempe", postalCode: "85281" },
+    { name: "Peoria", postalCode: "85345" },
+    { name: "Surprise", postalCode: "85374" },
+    { name: "Yuma", postalCode: "85364" },
+    { name: "Avondale", postalCode: "85323" },
+    { name: "Goodyear", postalCode: "85338" },
+    { name: "Flagstaff", postalCode: "86001" },
+    { name: "Buckeye", postalCode: "85326" },
+    { name: "Lake Havasu City", postalCode: "86403" },
+    { name: "Casa Grande", postalCode: "85122" },
+    { name: "Sierra Vista", postalCode: "85635" },
+    { name: "Maricopa", postalCode: "85138" },
+    { name: "Oro Valley", postalCode: "85737" },
+    { name: "Prescott", postalCode: "86301" },
+    { name: "Bullhead City", postalCode: "86429" },
+    { name: "Prescott Valley", postalCode: "86314" },
+    { name: "Marana", postalCode: "85653" },
+    { name: "Apache Junction", postalCode: "85120" },
+    { name: "Queen Creek", postalCode: "85142" },
+    { name: "Kingman", postalCode: "86401" },
+    { name: "Payson", postalCode: "85541" },
+    { name: "San Luis", postalCode: "85349" },
+    { name: "Nogales", postalCode: "85621" },
+  ],
+};

package/src/countries/US/district/arkansas.js

@@ -0,0 +1,38 @@
+export const arkansas = {
+  name: "arkansas",
+  cities: [
+    { name: "Little Rock", postalCode: "72201" },
+    { name: "Fort Smith", postalCode: "72901" },
+    { name: "Fayetteville", postalCode: "72701" },
+    { name: "Springdale", postalCode: "72762" },
+    { name: "Jonesboro", postalCode: "72401" },
+    { name: "North Little Rock", postalCode: "72114" },
+    { name: "Conway", postalCode: "72032" },
+    { name: "Rogers", postalCode: "72756" },
+    { name: "Pine Bluff", postalCode: "71601" },
+    { name: "Bentonville", postalCode: "72712" },
+    { name: "Hot Springs", postalCode: "71901" },
+    { name: "Benton", postalCode: "72015" },
+    { name: "Sherwood", postalCode: "72120" },
+    { name: "Texarkana", postalCode: "71854" },
+    { name: "Russellville", postalCode: "72801" },
+    { name: "Bella Vista", postalCode: "72714" },
+    { name: "Paragould", postalCode: "72450" },
+    { name: "Cabot", postalCode: "72023" },
+    { name: "West Memphis", postalCode: "72301" },
+    { name: "Van Buren", postalCode: "72956" },
+    { name: "Searcy", postalCode: "72143" },
+    { name: "Bryant", postalCode: "72022" },
+    { name: "El Dorado", postalCode: "71730" },
+    { name: "Maumelle", postalCode: "72113" },
+    { name: "Hope", postalCode: "71801" },
+    { name: "Blytheville", postalCode: "72315" },
+    { name: "Morrilton", postalCode: "72110" },
+    { name: "Forrest City", postalCode: "72335" },
+    { name: "Helena-West Helena", postalCode: "72342" },
+    { name: "Camden", postalCode: "71701" },
+    { name: "Magnolia", postalCode: "71753" },
+    { name: "Harrison", postalCode: "72601" },
+    { name: "Mountain Home", postalCode: "72653" },
+  ],
+};