bangladeshi-geo-data v1.0.1
š Bangladesh Geo Data (Divisions, Districts, Upazilas)
š Overview
bangladeshi-geo-data
provides Bangladesh's geographical data, including Divisions, Districts, and Upazilas, in a structured and searchable format.
ā Supports English & Bangla names\ ā Efficient search functionality\ ā Lightweight & easy to use
š¦ Installation
Using NPM
npm install bangladeshi-geo-data
Using Yarn
yarn add bangladeshi-geo-data
š Usage Examples
1ļøā£ Importing the Package
import { getDivisions, getDivision, getDistricts, getUpazilas, searchGeoData } from "bangladeshi-geo-data";
2ļøā£ Get All Divisions
console.log(getDivisions());
3ļøā£ Get Division by ID or Name
console.log(getDivision(1)); // Fetch division by ID
console.log(getDivision("Dhaka")); // Fetch division by name
console.log(getDivision("ą¦¢ą¦¾ą¦ą¦¾")); // Fetch division by Bangla name
4ļøā£ Get Districts by Division ID or Name
console.log(getDistricts(1)); // Fetch districts in division ID 1
console.log(getDistricts("Dhaka")); // Fetch districts in Dhaka division
5ļøā£ Get Upazilas by District Name
console.log(getUpazilas("Dhaka", "Dhaka")); // Fetch Upazilas in Dhaka District
6ļøā£ Search for Any Division, District, or Upazila
console.log(searchGeoData("Gazipur"));
console.log(searchGeoData("ą¦øą¦¾ą¦ą¦¾ą¦°")); // Bangla search
šÆ Real-Life Use Cases
1ļøā£ E-commerce Address Management
If you're building an e-commerce platform, you can use bangladeshi-geo-data
to allow users to select their division, district, and upazila while filling out their shipping address.
const userDivision = getDivision("Dhaka");
const userDistricts = getDistricts("Dhaka");
const userUpazilas = getUpazilas("Dhaka", "Dhaka");
2ļøā£ Government & NGO Data Analysis
Organizations working in rural development can filter and analyze data by region.
const floodProneDistricts = ["Sunamganj", "Sylhet", "Kurigram"];
const districtsData = floodProneDistricts.map((name) => getDistricts(name));
3ļøā£ Location-Based Filtering in Apps
If you're building a real estate, healthcare, or service-based app, you can filter data based on users' locations.
const userSearch = searchGeoData("Comilla");
console.log("Matching Locations:", userSearch);
šÆ Features
- š Accurate Geo Data (Bangladesh's Divisions, Districts, and Upazilas)
- š Searchable (Find by ID, English name, or Bangla name)
- š Lightweight & Fast
- š Regularly Updated
- š Well-structured TypeScript support
āļø API Methods
Method | Description | Input Type | Example Input | |
---|---|---|---|---|
getDivisions() | Get all divisions | () | getDivisions() | |
getDivision() | Get a division by ID or Name | number|string | getDivision(1) / getDivision("Dhaka") | |
getDistricts() | Get districts by Division ID or Name | number|string | getDistricts("Dhaka") | |
getUpazilas() | Get upazilas by District Name & Division | string,string | getUpazilas("Dhaka", "Dhaka") | |
searchGeoData() | Search for any division, district, or upazila | string | searchGeoData("Gazipur") |
š ļø Contributing
Contributions are welcome! š\ To contribute:
- Fork this repository
- Create a new feature branch
- Submit a Pull Request (PR)
š If you find any missing data or incorrect names, please open an issue.
š License
Licensed under the MIT License.\ You are free to use, modify, and distribute this package.
š Maintainer: Mehedi Hasan Khairul\ š NPM Package: bangladeshi-geo-data
š¢ Contact & Support
š GitHub: GitHub Repo\ š NPM: NPM Package\ š Facebook: Facebook Profile
š Enjoy using bangladeshi-geo-data
! Let us know if you have any suggestions or feedback! š