bd-address-pro

Complete Bangladesh address data package with all 8 divisions, 64 districts, 495 upazilas, and 4,579 unions. Includes Bengali (বাংলা) names, coordinates, and powerful search functionality.

Live Demo

Check out the interactive demo to explore all features: https://bd-address-pro.vercel.app/

Features

• ✅ Complete data for all 8 Divisions, 64 Districts, 495 Upazilas, and 4,579 Unions
• ✅ Bengali (বাংলা) names for all locations
• ✅ Postal codes for all districts (ranges) and upazilas (specific codes)
• ✅ TypeScript support with full type definitions
• ✅ Powerful search with fuzzy matching and autocomplete
• ✅ Geo-coordinates for divisions and districts
• ✅ Zero dependencies - lightweight and fast
• ✅ Type-safe enums for all locations
• ✅ Tree-shakeable - import only what you need
• ✅ Full hierarchy - Division → District → Upazila → Union

Installation

# npm
npm install bd-address-pro

# yarn
yarn add bd-address-pro

# pnpm
pnpm add bd-address-pro

# bun
bun add bd-address-pro

Quick Start

import {
  getAllDivisions,
  getDistrictsByDivision,
  getUpazilasByDistrict,
  getUnionsByUpazila,
  search,
} from 'bd-address-pro';

// Get all divisions
const divisions = getAllDivisions();
console.log(divisions);
// [{ id: 1, name: 'Dhaka', bnName: 'ঢাকা', slug: 'dhaka', ... }, ...]

// Get districts in Dhaka division
const dhakaDistricts = getDistrictsByDivision(1);
console.log(dhakaDistricts);
// [{ id: 18, name: 'Dhaka', bnName: 'ঢাকা', divisionId: 1, ... }, ...]

// Get unions in an upazila
const unions = getUnionsByUpazila(1);
console.log(unions);
// [{ id: 1, name: 'Amtli', bnName: 'আমতলী', upazilaId: 1, ... }, ...]

// Search for locations
const results = search('সিলেট');
console.log(results.divisions); // Sylhet division
console.log(results.districts); // Sylhet district

API Reference

Data Access Functions

getAllDivisions()

Returns all 8 divisions of Bangladesh.

import { getAllDivisions } from 'bd-address-pro';

const divisions = getAllDivisions();
// Returns: Division[]

getAllDistricts()

Returns all 64 districts of Bangladesh.

import { getAllDistricts } from 'bd-address-pro';

const districts = getAllDistricts();
// Returns: District[]

getAllUpazilas()

Returns all 495 upazilas of Bangladesh.

import { getAllUpazilas } from 'bd-address-pro';

const upazilas = getAllUpazilas();
// Returns: Upazila[]

getAllUnions()

Returns all 4,579 unions of Bangladesh.

import { getAllUnions } from 'bd-address-pro';

const unions = getAllUnions();
// Returns: Union[]

Division Functions

getDivisionById(id: number)

Get a division by its ID.

import { getDivisionById } from 'bd-address-pro';

const dhaka = getDivisionById(1);
// { id: 1, name: 'Dhaka', bnName: 'ঢাকা', slug: 'dhaka', ... }

getDivisionBySlug(slug: string)

Get a division by its URL-friendly slug.

import { getDivisionBySlug } from 'bd-address-pro';

const sylhet = getDivisionBySlug('sylhet');
// { id: 6, name: 'Sylhet', bnName: 'সিলেট', slug: 'sylhet', ... }

getDivisionByName(name: string)

Get a division by English or Bengali name.

import { getDivisionByName } from 'bd-address-pro';

// English name
const chattogram = getDivisionByName('Chattogram');

// Bengali name
const rajshahi = getDivisionByName('রাজশাহী');

District Functions

getDistrictById(id: number)

Get a district by its ID.

import { getDistrictById } from 'bd-address-pro';

const cox = getDistrictById(12);
// { id: 12, name: "Cox's Bazar", bnName: 'কক্সবাজার', divisionId: 2, ... }

getDistrictBySlug(slug: string)

Get a district by its slug.

import { getDistrictBySlug } from 'bd-address-pro';

const gazipur = getDistrictBySlug('gazipur');
// { id: 20, name: 'Gazipur', bnName: 'গাজীপুর', divisionId: 1, ... }

getDistrictByName(name: string)

Get a district by English or Bengali name.

import { getDistrictByName } from 'bd-address-pro';

const cumilla = getDistrictByName('কুমিল্লা');
// { id: 11, name: 'Cumilla', bnName: 'কুমিল্লা', ... }

getDistrictsByDivision(divisionId: number)

Get all districts in a division.

import { getDistrictsByDivision } from 'bd-address-pro';

const khulnaDistricts = getDistrictsByDivision(4);
// Returns all 10 districts in Khulna division

getDistrictsByDivisionSlug(divisionSlug: string)

Get all districts by division slug.

import { getDistrictsByDivisionSlug } from 'bd-address-pro';

const rangpurDistricts = getDistrictsByDivisionSlug('rangpur');
// Returns all 8 districts in Rangpur division

Upazila Functions

getUpazilaById(id: number)

Get an upazila by its ID.

import { getUpazilaById } from 'bd-address-pro';

const savar = getUpazilaById(151);
// { id: 151, name: 'Savar', bnName: 'সাভার', districtId: 18, ... }

getUpazilaBySlug(slug: string)

Get an upazila by its slug.

import { getUpazilaBySlug } from 'bd-address-pro';

const sreemangal = getUpazilaBySlug('sreemangal');
// { id: 470, name: 'Sreemangal', bnName: 'শ্রীমঙ্গল', districtId: 62, ... }

getUpazilaByName(name: string)

Get an upazila by English or Bengali name.

import { getUpazilaByName } from 'bd-address-pro';

const teknaf = getUpazilaByName('টেকনাফ');
// { id: 106, name: 'Teknaf', bnName: 'টেকনাফ', districtId: 12, ... }

getUpazilasByDistrict(districtId: number)

Get all upazilas in a district.

import { getUpazilasByDistrict } from 'bd-address-pro';

const dhakaUpazilas = getUpazilasByDistrict(18);
// Returns: Dhamrai, Dohar, Keraniganj, Nawabganj, Savar

getUpazilasByDistrictSlug(districtSlug: string)

Get all upazilas by district slug.

import { getUpazilasByDistrictSlug } from 'bd-address-pro';

const sylhetUpazilas = getUpazilasByDistrictSlug('sylhet');
// Returns all 13 upazilas in Sylhet district

getUpazilasByDivision(divisionId: number)

Get all upazilas in a division.

import { getUpazilasByDivision } from 'bd-address-pro';

const barishalUpazilas = getUpazilasByDivision(5);
// Returns all upazilas in Barishal division

Union Functions

getUnionById(id: number)

Get a union by its ID.

import { getUnionById } from 'bd-address-pro';

const union = getUnionById(1);
// { id: 1, name: 'Amtli', bnName: 'আমতলী', slug: 'amtli_amtali', upazilaId: 1 }

getUnionBySlug(slug: string)

Get a union by its slug.

import { getUnionBySlug } from 'bd-address-pro';

const union = getUnionBySlug('amtli_amtali');
// { id: 1, name: 'Amtli', bnName: 'আমতলী', slug: 'amtli_amtali', upazilaId: 1 }

getUnionByName(name: string)

Get a union by English or Bengali name.

import { getUnionByName } from 'bd-address-pro';

// English name
const union1 = getUnionByName('Amtli');

// Bengali name  
const union2 = getUnionByName('আমতলী');

getUnionsByUpazila(upazilaId: number)

Get all unions in an upazila.

import { getUnionsByUpazila } from 'bd-address-pro';

const unions = getUnionsByUpazila(1); // Amtali upazila
// Returns all unions in Amtali upazila

getUnionsByUpazilaSlug(upazilaSlug: string)

Get all unions by upazila slug.

import { getUnionsByUpazilaSlug } from 'bd-address-pro';

const unions = getUnionsByUpazilaSlug('amtali');
// Returns all unions in Amtali upazila

getUnionsByDistrict(districtId: number)

Get all unions in a district.

import { getUnionsByDistrict } from 'bd-address-pro';

const unions = getUnionsByDistrict(1); // Barguna district
// Returns all unions in Barguna district

getUnionsByDivision(divisionId: number)

Get all unions in a division.

import { getUnionsByDivision } from 'bd-address-pro';

const unions = getUnionsByDivision(5); // Barishal division
// Returns all unions in Barishal division

Relationship Functions

getDivisionOfDistrict(districtId: number)

Get the parent division of a district.

import { getDivisionOfDistrict } from 'bd-address-pro';

const division = getDivisionOfDistrict(10); // Chattogram district
// { id: 2, name: 'Chattogram', bnName: 'চট্টগ্রাম', ... }

getDistrictOfUpazila(upazilaId: number)

Get the parent district of an upazila.

import { getDistrictOfUpazila } from 'bd-address-pro';

const district = getDistrictOfUpazila(151); // Savar upazila
// { id: 18, name: 'Dhaka', bnName: 'ঢাকা', ... }

getUpazilaOfUnion(unionId: number)

Get the parent upazila of a union.

import { getUpazilaOfUnion } from 'bd-address-pro';

const upazila = getUpazilaOfUnion(1); // Amtli union
// { id: 1, name: 'Amtali', bnName: 'আমতলী', ... }

getFullAddress(upazilaId: number)

Get complete address hierarchy for an upazila.

import { getFullAddress } from 'bd-address-pro';

const address = getFullAddress(151); // Savar
// {
//   division: { id: 1, name: 'Dhaka', bnName: 'ঢাকা', ... },
//   district: { id: 18, name: 'Dhaka', bnName: 'ঢাকা', ... },
//   upazila: { id: 151, name: 'Savar', bnName: 'সাভার', ... }
// }

getFullAddressBySlug(upazilaSlug: string)

Get full address by upazila slug.

import { getFullAddressBySlug } from 'bd-address-pro';

const address = getFullAddressBySlug('sreemangal');
// Returns full address hierarchy for Sreemangal

getFullAddressOfUnion(unionId: number)

Get complete address hierarchy for a union (includes union in result).

import { getFullAddressOfUnion } from 'bd-address-pro';

const address = getFullAddressOfUnion(1); // Amtli union
// {
//   division: { id: 5, name: 'Barishal', bnName: 'বরিশাল', ... },
//   district: { id: 1, name: 'Barguna', bnName: 'বরগুনা', ... },
//   upazila: { id: 1, name: 'Amtali', bnName: 'আমতলী', ... },
//   union: { id: 1, name: 'Amtli', bnName: 'আমতলী', ... }
// }

Formatting Functions

formatAddress(address, options?)

Format a full address as a string.

import { getFullAddress, formatAddress } from 'bd-address-pro';

const address = getFullAddress(151);

// English (default)
formatAddress(address);
// "Savar, Dhaka, Dhaka"

// Bengali
formatAddress(address, { language: 'bn' });
// "সাভার, ঢাকা, ঢাকা"

// Custom separator
formatAddress(address, { separator: ' > ' });
// "Savar > Dhaka > Dhaka"

// Partial address
formatAddress(address, { includeUpazila: false });
// "Dhaka, Dhaka"

formatAddressBengali(address)

Format address in Bengali.

import { getFullAddress, formatAddressBengali } from 'bd-address-pro';

const address = getFullAddress(470); // Sreemangal
formatAddressBengali(address);
// "শ্রীমঙ্গল, মৌলভীবাজার, সিলেট"

formatAddressEnglish(address)

Format address in English.

import { getFullAddress, formatAddressEnglish } from 'bd-address-pro';

const address = getFullAddress(470);
formatAddressEnglish(address);
// "Sreemangal, Moulvibazar, Sylhet"

Search Functions

search(query, options?)

Search across all locations with fuzzy matching.

import { search } from 'bd-address-pro';

// Basic search
const results = search('dhaka');
console.log(results.divisions); // Dhaka division
console.log(results.districts); // Dhaka district
console.log(results.upazilas);  // Related upazilas
console.log(results.unions);    // Related unions

// Bengali search
const bnResults = search('সিলেট');

// With options
const filtered = search('dhaka', {
  types: ['district', 'union'], // Only search districts and unions
  limit: 5,                     // Max 5 results per type
  threshold: 0.5,               // Minimum match score (0-1)
  includeEnglish: true,         // Search English names
  includeBengali: true,         // Search Bengali names
  includeSlug: true,            // Search slugs
});

quickSearch(query, options?)

Returns first matching item of any type.

import { quickSearch } from 'bd-address-pro';

const result = quickSearch('sylhet');
// { id: 6, name: 'Sylhet', bnName: 'সিলেট', ... }

searchDivisions(query, options?)

Search only in divisions.

import { searchDivisions } from 'bd-address-pro';

const results = searchDivisions('চট্টগ্রাম');
// [{ item: { name: 'Chattogram', ... }, score: 1, matchedField: 'bnName' }]

searchDistricts(query, options?)

Search only in districts.

import { searchDistricts } from 'bd-address-pro';

const results = searchDistricts('bogura');
// [{ item: { name: 'Bogura', ... }, score: 1, matchedField: 'slug' }]

searchUpazilas(query, options?)

Search only in upazilas.

import { searchUpazilas } from 'bd-address-pro';

const results = searchUpazilas('savar');
// [{ item: { name: 'Savar', ... }, score: 1, matchedField: 'name' }]

searchUnions(query, options?)

Search only in unions.

import { searchUnions } from 'bd-address-pro';

const results = searchUnions('আমতলী');
// [{ item: { name: 'Amtli', bnName: 'আমতলী', ... }, score: 1, matchedField: 'bnName' }]

autocomplete(query, options?)

Get autocomplete suggestions (prefix matching).

import { autocomplete } from 'bd-address-pro';

const suggestions = autocomplete('Dha');
// [
//   { name: 'Dhaka', bnName: 'ঢাকা', type: 'division', item: {...} },
//   { name: 'Dhaka', bnName: 'ঢাকা', type: 'district', item: {...} },
//   { name: 'Dhamrai', bnName: 'ধামরাই', type: 'upazila', item: {...} },
//   ...
// ]

fuzzySearch(query, options?)

Search with higher typo tolerance.

import { fuzzySearch } from 'bd-address-pro';

// Handles typos
const results = fuzzySearch('Dahka'); // typo for 'Dhaka'
// Still returns Dhaka division and district

searchBengali(query, options?)

Search only in Bengali names.

import { searchBengali } from 'bd-address-pro';

const results = searchBengali('ময়মনসিংহ');
// Returns Mymensingh division and district

searchEnglish(query, options?)

Search only in English names.

import { searchEnglish } from 'bd-address-pro';

const results = searchEnglish('Rajshahi');
// Returns Rajshahi division and district

Statistics Functions

getStats()

Get statistics about the location data.

import { getStats } from 'bd-address-pro';

const stats = getStats();
// {
//   totalDivisions: 8,
//   totalDistricts: 64,
//   totalUpazilas: 495,
//   totalUnions: 4579,
//   divisionDistrictMap: { 1: 13, 2: 11, ... },
//   districtUpazilaMap: { 1: 6, 2: 10, ... },
//   upazilaUnionMap: { 1: 9, 2: 7, ... }
// }

getDistrictCount(divisionId: number)

Get number of districts in a division.

import { getDistrictCount } from 'bd-address-pro';

const count = getDistrictCount(1); // Dhaka division
// 13

getUpazilaCount(districtId: number)

Get number of upazilas in a district.

import { getUpazilaCount } from 'bd-address-pro';

const count = getUpazilaCount(10); // Chattogram district
// 15

getUpazilaCountByDivision(divisionId: number)

Get total upazilas in a division.

import { getUpazilaCountByDivision } from 'bd-address-pro';

const count = getUpazilaCountByDivision(6); // Sylhet division
// 40

Postal Code Functions

getDistrictPostalCode(districtId: number)

Get postal code range for a district.

import { getDistrictPostalCode } from 'bd-address-pro';

const range = getDistrictPostalCode(18); // Dhaka district
// "1000-1399"

getUpazilaPostalCode(upazilaId: number)

Get specific postal code for an upazila.

import { getUpazilaPostalCode } from 'bd-address-pro';

const code = getUpazilaPostalCode(151); // Savar upazila
// "1340"

getUnionPostalCode(unionId: number)

Get postal code for a union (via its upazila).

import { getUnionPostalCode } from 'bd-address-pro';

const code = getUnionPostalCode(1); // Amtli union
// "8730"

getPostalInfo(upazilaId: number)

Get full postal information for a location. Returns a PostalInfo object.

import { getPostalInfo, PostalInfo } from 'bd-address-pro';

const info: PostalInfo | undefined = getPostalInfo(151); // Savar
// {
//   postalCode: "1340",
//   districtRange: "1000-1399"
// }

Validation Functions

isValidDivision(id: number)

Check if a division ID is valid.

import { isValidDivision } from 'bd-address-pro';

isValidDivision(1);  // true
isValidDivision(99); // false

isValidDistrict(id: number)

Check if a district ID is valid.

import { isValidDistrict } from 'bd-address-pro';

isValidDistrict(18); // true
isValidDistrict(99); // false

isValidUpazila(id: number)

Check if an upazila ID is valid.

import { isValidUpazila } from 'bd-address-pro';

isValidUpazila(151); // true
isValidUpazila(999); // false

isDistrictInDivision(districtId, divisionId)

Check if a district belongs to a division.

import { isDistrictInDivision } from 'bd-address-pro';

isDistrictInDivision(18, 1); // true (Dhaka district in Dhaka division)
isDistrictInDivision(18, 2); // false

isUpazilaInDistrict(upazilaId, districtId)

Check if an upazila belongs to a district.

import { isUpazilaInDistrict } from 'bd-address-pro';

isUpazilaInDistrict(151, 18); // true (Savar in Dhaka district)
isUpazilaInDistrict(151, 20); // false

isUpazilaInDivision(upazilaId, divisionId)

Check if an upazila belongs to a division.

import { isUpazilaInDivision } from 'bd-address-pro';

isUpazilaInDivision(151, 1); // true (Savar in Dhaka division)
isUpazilaInDivision(151, 2); // false

List Helpers

getDivisionNames(language?)

Get list of division names.

import { getDivisionNames } from 'bd-address-pro';

getDivisionNames('en');
// ['Dhaka', 'Chattogram', 'Rajshahi', 'Khulna', 'Barishal', 'Sylhet', 'Rangpur', 'Mymensingh']

getDivisionNames('bn');
// ['ঢাকা', 'চট্টগ্রাম', 'রাজশাহী', 'খুলনা', 'বরিশাল', 'সিলেট', 'রংপুর', 'ময়মনসিংহ']

getDistrictNames(language?)

Get list of district names.

import { getDistrictNames } from 'bd-address-pro';

getDistrictNames('en'); // All 64 English district names
getDistrictNames('bn'); // All 64 Bengali district names

getUpazilaNames(language?)

Get list of upazila names.

import { getUpazilaNames } from 'bd-address-pro';

getUpazilaNames('en'); // All 495 English upazila names
getUpazilaNames('bn'); // All 495 Bengali upazila names

getDivisionOptions()

Get dropdown options for divisions.

import { getDivisionOptions } from 'bd-address-pro';

const options = getDivisionOptions();
// [
//   { value: 'dhaka', label: 'Dhaka', labelBn: 'ঢাকা' },
//   { value: 'chattogram', label: 'Chattogram', labelBn: 'চট্টগ্রাম' },
//   ...
// ]

getDistrictOptions(divisionId?)

Get dropdown options for districts.

import { getDistrictOptions } from 'bd-address-pro';

// All districts
const allOptions = getDistrictOptions();

// Filtered by division
const dhakaDistrictOptions = getDistrictOptions(1);
// [
//   { value: 'dhaka', label: 'Dhaka', labelBn: 'ঢাকা' },
//   { value: 'gazipur', label: 'Gazipur', labelBn: 'গাজীপুর' },
//   ...
// ]

getUpazilaOptions(districtId?)

Get dropdown options for upazilas.

import { getUpazilaOptions } from 'bd-address-pro';

// All upazilas
const allOptions = getUpazilaOptions();

// Filtered by district
const dhakaUpazilaOptions = getUpazilaOptions(18);
// [
//   { value: 'dhamrai', label: 'Dhamrai', labelBn: 'ধামরাই' },
//   { value: 'savar', label: 'Savar', labelBn: 'সাভার' },
//   ...
// ]

Type-Safe Enums

Use enums for type-safe location access.

import {
  BangladeshDivision,
  BangladeshDistrict,
  BangladeshUpazila,
  getDivisionBySlug,
  getDistrictBySlug,
  getUpazilaBySlug,
} from 'bd-address-pro';

// Division enum
const dhaka = getDivisionBySlug(BangladeshDivision.DHAKA);
const sylhet = getDivisionBySlug(BangladeshDivision.SYLHET);

// District enum
const coxsBazar = getDistrictBySlug(BangladeshDistrict.COXS_BAZAR);
const brahmanbaria = getDistrictBySlug(BangladeshDistrict.BRAHMANBARIA);

// Upazila enum
const savar = getUpazilaBySlug(BangladeshUpazila.SAVAR);
const teknaf = getUpazilaBySlug(BangladeshUpazila.TEKNAF);

Raw Data Access

For advanced usage, access raw data arrays via getter functions.

import { getRawDivisions, getRawDistricts, getRawUpazilas, getRawUnions } from 'bd-address-pro';

console.log(getRawDivisions().length);  // 8
console.log(getRawDistricts().length);  // 64
console.log(getRawUpazilas().length);   // 495
console.log(getRawUnions().length);     // 4579

TypeScript Support

Full TypeScript support with exported types:

import type {
  Division,
  District,
  Upazila,
  Union,
  FullAddress,
  Coordinates,
  SearchResult,
  LocationSearchResult,
  LocationType,
  AnyLocation,
  LocationStats,
  SearchOptions,
  PostalInfo,
} from 'bd-address-pro';

Type Definitions

interface Division {
  id: number;
  name: string;
  bnName: string;
  slug: string;
  coordinates?: Coordinates;
  area?: number;
  population?: number;
  literacy?: number;
}

interface District {
  id: number;
  name: string;
  bnName: string;
  slug: string;
  divisionId: number;
  coordinates?: Coordinates;
  postalCode?: string;  // Postal code range (e.g., "1000-1399")
}

interface Upazila {
  id: number;
  name: string;
  bnName: string;
  slug: string;
  districtId: number;
  postalCode?: string;  // Specific 4-digit postal code (e.g., "1340")
}

interface Union {
  id: number;
  name: string;
  bnName: string;
  slug: string;
  upazilaId: number;
}

interface FullAddress {
  division: Division;
  district: District;
  upazila: Upazila;
  union?: Union;  // Optional - present when using getFullAddressOfUnion
}

interface PostalInfo {
  postalCode: string;    // Specific upazila postal code (e.g., "1340")
  districtRange: string; // District postal code range (e.g., "1000-1399")
}

type LocationType = 'division' | 'district' | 'upazila' | 'union';

Use Cases

Building a Cascading Dropdown (React Example)

import { useState } from 'react';
import {
  getDivisionOptions,
  getDistrictOptions,
  getUpazilaOptions,
  getDivisionBySlug,
  getDistrictBySlug,
} from 'bd-address-pro';

function AddressSelector() {
  const [divisionSlug, setDivisionSlug] = useState('');
  const [districtSlug, setDistrictSlug] = useState('');
  const [upazilaSlug, setUpazilaSlug] = useState('');

  const divisions = getDivisionOptions();
  const division = divisionSlug ? getDivisionBySlug(divisionSlug) : null;
  const districts = division ? getDistrictOptions(division.id) : [];
  const district = districtSlug ? getDistrictBySlug(districtSlug) : null;
  const upazilas = district ? getUpazilaOptions(district.id) : [];

  return (
    <div>
      <select
        value={divisionSlug}
        onChange={(e) => {
          setDivisionSlug(e.target.value);
          setDistrictSlug('');
          setUpazilaSlug('');
        }}
      >
        <option value="">Select Division</option>
        {divisions.map((d) => (
          <option key={d.value} value={d.value}>
            {d.label} ({d.labelBn})
          </option>
        ))}
      </select>

      <select
        value={districtSlug}
        onChange={(e) => {
          setDistrictSlug(e.target.value);
          setUpazilaSlug('');
        }}
        disabled={!divisionSlug}
      >
        <option value="">Select District</option>
        {districts.map((d) => (
          <option key={d.value} value={d.value}>
            {d.label} ({d.labelBn})
          </option>
        ))}
      </select>

      <select
        value={upazilaSlug}
        onChange={(e) => setUpazilaSlug(e.target.value)}
        disabled={!districtSlug}
      >
        <option value="">Select Upazila</option>
        {upazilas.map((u) => (
          <option key={u.value} value={u.value}>
            {u.label} ({u.labelBn})
          </option>
        ))}
      </select>
    </div>
  );
}

Search with Autocomplete

import { autocomplete, getFullAddressBySlug } from 'bd-address-pro';

function handleSearch(query: string) {
  const suggestions = autocomplete(query, { limit: 10 });

  suggestions.forEach((suggestion) => {
    console.log(`${suggestion.name} (${suggestion.bnName}) - ${suggestion.type}`);
  });
}

// User types "Mir"
handleSearch('Mir');
// Output:
// Mirzapur (মির্জাপুর) - upazila
// Mirsharai (মীরসরাই) - upazila
// Mirpur (মিরপুর) - upazila
// ...

Validation in Forms

import {
  isValidDivision,
  isValidDistrict,
  isValidUpazila,
  isDistrictInDivision,
  isUpazilaInDistrict,
} from 'bd-address-pro';

function validateAddress(divisionId: number, districtId: number, upazilaId: number): boolean {
  // Check if IDs are valid
  if (!isValidDivision(divisionId)) return false;
  if (!isValidDistrict(districtId)) return false;
  if (!isValidUpazila(upazilaId)) return false;

  // Check hierarchical relationships
  if (!isDistrictInDivision(districtId, divisionId)) return false;
  if (!isUpazilaInDistrict(upazilaId, districtId)) return false;

  return true;
}

Data Structure

Administrative Hierarchy

Bangladesh
├── 8 Divisions
│   ├── 64 Districts
│   │   ├── 495 Upazilas
│   │   │   └── 4,579 Unions

Divisions

| ID | Name | Bengali | Districts | Upazilas | Unions | |----|------|---------|-----------|----------|--------| | 1 | Dhaka | ঢাকা | 13 | 90 | ~900 | | 2 | Chattogram | চট্টগ্রাম | 11 | 99 | ~950 | | 3 | Rajshahi | রাজশাহী | 8 | 70 | ~650 | | 4 | Khulna | খুলনা | 10 | 59 | ~550 | | 5 | Barishal | বরিশাল | 6 | 42 | ~380 | | 6 | Sylhet | সিলেট | 4 | 40 | ~350 | | 7 | Rangpur | রংপুর | 8 | 58 | ~530 | | 8 | Mymensingh | ময়মনসিংহ | 4 | 37 | ~270 |

Totals: 8 Divisions → 64 Districts → 495 Upazilas → 4,579 Unions

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT © Abid Hasan

Support

If you find this package helpful, please consider giving it a ⭐ on GitHub!