hududlar
v1.0.2
Published
O'zbekiston hududlari: viloyatlar, tumanlar, qishloqlar uchun TypeScript kutubxonasi
Maintainers
Readme
📦 hududlar
O'zbekiston hududiy ma'lumotlar kutubxonasi: viloyatlar, tumanlar va qishloqlarni TypeScript yordamida osongina olish.
✨ Imkoniyatlar
getRegions()– barcha viloyatlarni olishgetDistrictsByRegionId(regionId)– viloyatga tegishli tumanlargetVillagesByDistrictId(districtId)– tumanga tegishli qishloqlarfindRegionById(id)– ID bo‘yicha viloyatfindDistrictById(id)– ID bo‘yicha tumanfindVillageById(id)– ID bo‘yicha qishloqgetRegionTree()– viloyat → tuman → qishloq daraxti shaklida
🚀 O‘rnatish
npm install hududlar
# yoki
yarn add hududlar📦 Foydalanish
1. Barcha viloyatlarni olish
import { getRegions } from 'hududlar'
const regions = getRegions()
console.log(regions[0].name_uz) // "Andijon viloyati"2. Viloyatga tegishli tumanlar
import { getDistrictsByRegionId } from 'hududlar'
const districts = getDistrictsByRegionId(2)
console.log(districts.map(d => d.name_uz))3. Tumanga tegishli qishloqlar
import { getVillagesByDistrictId } from 'hududlar'
const villages = getVillagesByDistrictId(16)
console.log(villages.length) // 134. To‘liq daraxt ko‘rinishi (viloyat → tuman → qishloq)
import { getRegionTree } from 'hududlar'
const tree = getRegionTree()
console.log(tree[0].districts[0].villages)5. ID bo‘yicha topish
import {
findRegionById,
findDistrictById,
findVillageById
} from 'hududlar'
const region = findRegionById(2)
const district = findDistrictById(16)
const village = findVillageById(217)🧱 Tiplar
interface Region {
id: number
soato_id: number
name_uz: string
name_oz: string
name_ru: string
}
interface District {
id: number
region_id: number
soato_id: number
name_uz: string
name_oz: string
name_ru: string
}
interface Village {
id: number
district_id: number
soato_id: number
name_uz: string
name_oz: string
name_ru: string
}💡 Advanced
getRegionTree() funksiyasi quyidagi tuzilmani qaytaradi:
{
id: number
name_uz: string
...
districts: [
{
id: number
name_uz: string
...
villages: [
{
id: number
name_uz: string
...
}
]
}
]
}📄 Litsenziya
MIT © Akbar Iskanderov
🤝 Hissa qo‘shish
Pull request yoki issue ochish orqali takliflaringizni yuboring.
O‘zbekiston hududiy ma'lumotlarini ochiq va sifatli qilishga birga hissa qo‘shamiz!
