Hierarchy & Breadcrumbfungsi: getDetailWilayah(kode)
Fungsi getDetailWilayah()
Mendapatkan pohon hierarki lengkap (Desa ➔ Kecamatan ➔ Kabupaten ➔ Provinsi) hanya dari satu kode wilayah.
Solusi Ideal untuk Database Alamat & Checkout E-commerce:
Dalam database aplikasi, biasanya Anda hanya perlu menyimpan 1 kolom kode desa pengguna (misal: "3204052001"). Ketika ingin menampilkan alamat lengkap di invoice atau profil (contoh: "Cileunyi Kulon, Kec. Cileunyi, Kab. Bandung, Jawa Barat"), Anda cukup memanggil getDetailWilayah("3204052001") tanpa perlu melakukan join database yang rumit.
1. Spesifikasi Parameter
| Parameter | Tipe | Wajib? | Panjang Digit | Tingkat yang Dideteksi |
|---|---|---|---|---|
| kode | string | Wajib | 2 digit (misal: "32") | Otomatis terdeteksi sebagai Provinsi |
| 4 digit (misal: "3204" atau "32.04") | Otomatis terdeteksi sebagai Kabupaten/Kota | |||
| 6 digit (misal: "320405" atau "32.04.05") | Otomatis terdeteksi sebagai Kecamatan | |||
| 10 digit (misal: "3204052001" atau "32.04.05.2001") | Otomatis terdeteksi sebagai Desa/Kelurahan |
2. Tipe Data (TypeScript Interface)
export interface DetailWilayah {
/** Tingkat wilayah yang dicari */
tingkat: 'provinsi' | 'kabupaten' | 'kecamatan' | 'desa';
/** Kode wilayah tanpa titik */
kode: string;
/** Kode resmi Kemendagri dengan titik */
kode_kemendagri: string;
/** Nama wilayah terkait */
nama: string;
/** Info provinsi induk */
provinsi?: Provinsi;
/** Info kabupaten induk (jika tingkat >= kabupaten) */
kabupaten?: Kabupaten;
/** Info kecamatan induk (jika tingkat >= kecamatan) */
kecamatan?: Kecamatan;
/** Info desa (jika tingkat == desa) */
desa?: Desa;
}3. Contoh Kode Pemanggilan
import { getDetailWilayah } from 'daftar-wilayah-indonesia';
// Membongkar silsilah dari kode desa:
const detail = getDetailWilayah('3204052001');
if (detail) {
console.log(detail.tingkat); // "desa"
console.log(detail.nama); // "Cileunyi Kulon"
console.log(detail.kecamatan?.nama); // "Cileunyi"
console.log(detail.kabupaten?.nama); // "Kabupaten Bandung"
console.log(detail.provinsi?.nama); // "Jawa Barat"
// Format teks lengkap untuk alamat pengiriman:
const alamatLengkap = `${detail.nama}, Kec. ${detail.kecamatan?.nama}, ${detail.kabupaten?.nama}, ${detail.provinsi?.nama}`;
console.log(alamatLengkap);
// "Cileunyi Kulon, Kec. Cileunyi, Kabupaten Bandung, Jawa Barat"
}4. Contoh Hasil Respon Objek
{
"tingkat": "desa",
"kode": "3204052001",
"kode_kemendagri": "32.04.05.2001",
"nama": "Cileunyi Kulon",
"provinsi": {
"kode": "32",
"nama": "Jawa Barat"
},
"kabupaten": {
"kode": "3204",
"kode_kemendagri": "32.04",
"kode_provinsi": "32",
"nama": "Kabupaten Bandung",
"tipe": "Kabupaten"
},
"kecamatan": {
"kode": "320405",
"kode_kemendagri": "32.04.05",
"kode_kabupaten": "3204",
"kode_provinsi": "32",
"nama": "Cileunyi"
},
"desa": {
"kode": "3204052001",
"kode_kemendagri": "32.04.05.2001",
"kode_kecamatan": "320405",
"kode_kabupaten": "3204",
"kode_provinsi": "32",
"nama": "Cileunyi Kulon"
}
}