country-data-filter 1.0.14 → 1.0.15

package/README.md

@@ -0,0 +1,105 @@
+Country Data Filter
+country-data-filter is an npm package designed to provide detailed country data, including provinces, districts, cities, and postal codes. This package is useful for applications that need to access and filter geographical information.
+
+Installation
+You can install the package via npm:
+
+bash
+Copy code
+npm install country-data-filter
+Usage
+Importing the Package
+In your JavaScript or TypeScript project, you can import the functions provided by the package.
+
+JavaScript
+javascript
+Copy code
+const { 
+  getProvincesDistrictsCitiesByCountryFunction, 
+  getCountryProvinceCityByDistrict, 
+  getCountryDistrictsCitiesByProvince, 
+  listFunctions 
+} = require('country-data-filter');
+TypeScript
+typescript
+Copy code
+import { 
+  getProvincesDistrictsCitiesByCountryFunction, 
+  getCountryProvinceCityByDistrict, 
+  getCountryDistrictsCitiesByProvince, 
+  listFunctions 
+} from 'country-data-filter';
+Functions
+getProvincesDistrictsCitiesByCountryFunction(code)
+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:
+
+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)
+Returns the country code, province, and cities for a given district name.
+
+Parameters:
+
+districtName (string): The name of the district.
+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)
+Returns the list of districts and cities for a given province name.
+
+Parameters:
+
+provinceName (string): The name of the province.
+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()
+Returns a list of all available functions in the package.
+
+Returns:
+
+An object containing the function names and their references.
+Example:
+
+javascript
+Copy code
+const functions = listFunctions();
+console.log(functions);
+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.
+
+Contributing
+If you want to contribute to this project, please follow these steps:
+
+Fork the repository.
+Create a new branch for your changes.
+Make your changes and add tests if applicable.
+Submit a pull request with a clear description of your changes.
+License
+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.14",
+  "version": "1.0.15",
   "description": "A package to filter country data",
   "main": "src/index.js",
   "types": "src/index.d.ts",