1.0.1 • Published 5 months ago

bangladeshi-geo-data v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
5 months ago

šŸ“Œ 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

MethodDescriptionInput TypeExample Input
getDivisions()Get all divisions()getDivisions()
getDivision()Get a division by ID or Namenumber|stringgetDivision(1) / getDivision("Dhaka")
getDistricts()Get districts by Division ID or Namenumber|stringgetDistricts("Dhaka")
getUpazilas()Get upazilas by District Name & Divisionstring,stringgetUpazilas("Dhaka", "Dhaka")
searchGeoData()Search for any division, district, or upazilastringsearchGeoData("Gazipur")

šŸ› ļø Contributing

Contributions are welcome! šŸŽ‰\ To contribute:

  1. Fork this repository
  2. Create a new feature branch
  3. 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! šŸš€

1.0.1

5 months ago

1.0.0

5 months ago