akwap/lib/index.d.ts

A Ugandan Geolocation flow.

export declare type District = {
    /**
     * District name
     */
    name: string;
    /**
     * District id
     */
    id: number;
    /**
     * District counties
     */
    counties: County[];
};
export declare type County = {
    /**
     * County name
     */
    name: string;
    /**
     * County id
     */
    id: number;
    /**
     * County sub counties
     */
    sub_counties: SubCounty[];
};
export declare type SubCounty = {
    /**
     * SubCounty name
     */
    name: string;
    /**
     * SubCounty id
     */
    id: number;
    /**
     * SubCounty parishes
     */
    parishes: Parish[];
};
export declare type Parish = {
    /**
     * Parish name
     */
    name: string;
    /**
     * Parish id
     */
    id: number;
    /**
     * Parish villages
     */
    villages: Village[];
};
export declare type Village = {
    /**
     * Village name
     */
    name: string;
    /**
     * Village id
     */
    id: number;
};
/**
 * Base Types without extra data
 */
export declare type BaseDistrict = {
    /**
     * District name
     */
    name: string;
    /**
     * District id
     */
    id: number;
};
export declare type BaseCounty = {
    /**
     * County name
     */
    name: string;
    /**
     * County id
     */
    id: number;
    /**
     * County district
     */
    district: BaseDistrict;
};
export declare type Base = {
    name: string;
    id: number;
};
export declare type BaseSubCounty = {
    /**
     * SubCounty name
     */
    name: string;
    /**
     * SubCounty id
     */
    id: number;
    /**
     * SubCounty county
     */
    county: Base;
    /**
     * SubCounty district
     */
    district: Base;
};
export declare type BaseParish = {
    /**
     * Parish name
     */
    name: string;
    /**
     * Parish id
     */
    id: number;
    /**
     * Parish sub county
     */
    sub_county: Base;
    /**
     * Parish county
     */
    county: Base;
    /**
     * Parish district
     */
    district: Base;
};
export declare type BaseVillage = {
    /**
     * Parish name
     */
    name: string;
    /**
     * Parish id
     */
    id: number;
    /**
     * Parish sub county
     */
    parish: Base;
    /**
     * Parish sub county
     */
    sub_county: Base;
    /**
     * Parish county
     */
    county: Base;
    /**
     * Parish district
     */
    district: Base;
};
export declare const districts: BaseDistrict[];
export declare const abim: District;
export declare const adjumani: District;
export declare const agago: District;
export declare const alebtong: District;
export declare const amolatar: District;
export declare const amudat: District;
export declare const amuria: District;
export declare const amuru: District;
export declare const apac: District;
export declare const arua: District;
export declare const budaka: District;
export declare const bududa: District;
export declare const bugiri: District;
export declare const bugweri: District;
export declare const buhweju: District;
export declare const buikwe: District;
export declare const bukedea: District;
export declare const bukomansimbi: District;
export declare const bukwo: District;
export declare const bulambuli: District;
export declare const buliisa: District;
export declare const bundibugyo: District;
export declare const bunyangabu: District;
export declare const bushenyi: District;
export declare const busia: District;
export declare const butaleja: District;
export declare const butambala: District;
export declare const butebo: District;
export declare const buvuma: District;
export declare const buyende: District;
export declare const dokolo: District;
export declare const gomba: District;
export declare const gulu: District;
export declare const hoima: District;
export declare const ibanda: District;
export declare const iganga: District;
export declare const isingiro: District;
export declare const jinja: District;
export declare const kaabong: District;
export declare const kabale: District;
export declare const kabarole: District;
export declare const kaberamaido: District;
export declare const kagadi: District;
export declare const kakumiro: District;
export declare const kalaki: District;
export declare const kalangala: District;
export declare const kaliro: District;
export declare const kalungu: District;
export declare const kampala: District;
export declare const kamuli: District;
export declare const kamwenge: District;
export declare const kanungu: District;
export declare const kapchorwa: District;
export declare const kapelebyong: District;
export declare const karenga: District;
export declare const kasanda: District;
export declare const kasese: District;
export declare const katakwi: District;
export declare const kayunga: District;
export declare const kazo: District;
export declare const kibaale: District;
export declare const kiboga: District;
export declare const kibuku: District;
export declare const kikuube: District;
export declare const kiruhura: District;
export declare const kiryandongo: District;
export declare const kisoro: District;
export declare const kitagwenda: District;
export declare const kitgum: District;
export declare const koboko: District;
export declare const kole: District;
export declare const kotido: District;
export declare const kumi: District;
export declare const kwania: District;
export declare const kween: District;
export declare const kyankwanzi: District;
export declare const kyegegwa: District;
export declare const kyenjojo: District;
export declare const kyotera: District;
export declare const lamwo: District;
export declare const lira: District;
export declare const luuka: District;
export declare const luweero: District;
export declare const lwengo: District;
export declare const lyantonde: District;
export declare const madiOkollo: District;
export declare const manafwa: District;
export declare const maracha: District;
export declare const masaka: District;
export declare const masindi: District;
export declare const mayuge: District;
export declare const mbale: District;
export declare const mbarara: District;
export declare const mitooma: District;
export declare const mityana: District;
export declare const moroto: District;
export declare const moyo: District;
export declare const mpigi: District;
export declare const mubende: District;
export declare const mukono: District;
export declare const nabilatuk: District;
export declare const nakapiripirit: District;
export declare const nakaseke: District;
export declare const nakasongola: District;
export declare const namayingo: District;
export declare const namisindwa: District;
export declare const namutumba: District;
export declare const napak: District;
export declare const nebbi: District;
export declare const ngora: District;
export declare const ntoroko: District;
export declare const ntungamo: District;
export declare const nwoya: District;
export declare const obongi: District;
export declare const omoro: District;
export declare const otuke: District;
export declare const oyam: District;
export declare const pader: District;
export declare const pakwach: District;
export declare const pallisa: District;
export declare const rakai: District;
export declare const rubanda: District;
export declare const rubirizi: District;
export declare const rukiga: District;
export declare const rukungiri: District;
export declare const rwampara: District;
export declare const serere: District;
export declare const sheema: District;
export declare const sironko: District;
export declare const soroti: District;
export declare const ssembabule: District;
export declare const tororo: District;
export declare const wakiso: District;
export declare const yumbe: District;
export declare const zombo: District;
/***
 * Helper methods
 */
export declare function getDistrict(district: string): District;
export declare function getCounty(county: string, accuracy?: number): BaseCounty[];
export declare function getSubCounty(subcounty: string, accuracy?: number): BaseSubCounty[];
export declare function getParish(parish: string, accuracy?: number): BaseParish[];
export declare function getVillage(village: string, accuracy?: number): BaseVillage[];
export declare function getVillageFromSubCounty({ sub_county, parish, village }: {
    sub_county: string;
    parish: string;
    village: string;
}, accuracy?: number): BaseVillage[];