UNPKG

@simoko/tw-zip

Version:

台灣縣市、行政區、郵遞區號(3碼/6碼)查詢工具,支援 React/Vue/Svelte/SolidJS/Angular

40 lines (38 loc) 1.15 kB
/** * 動態載入 zip6 資料 */ type AreaData = Record<string, string>; type CityAreaData = Record<string, AreaData>; type Zip3Map = Record<string, Record<string, string>>; interface CitiesData { cities: string[]; zip3: Zip3Map; } interface LoaderOptions { baseUrl?: string; } /** * 載入縣市列表和 zip3 對照表 */ declare function loadCitiesData(options?: LoaderOptions): Promise<CitiesData>; /** * 載入指定縣市的資料 */ declare function loadCityData(city: string, options?: LoaderOptions): Promise<CityAreaData>; /** * 預載入指定縣市 */ declare function preloadCities(cities: string[], options?: LoaderOptions): Promise<void>; /** * 取得已快取的縣市資料(同步) */ declare function getCachedCityData(city: string): CityAreaData | undefined; /** * 檢查縣市資料是否已快取 */ declare function isCityCached(city: string): boolean; /** * 清除快取 */ declare function clearCache(): void; export { type AreaData, type CitiesData, type CityAreaData, type LoaderOptions, type Zip3Map, clearCache, getCachedCityData, isCityCached, loadCitiesData, loadCityData, preloadCities };