UNPKG

@mardillu/us-cities-utils

Version:

A lightweight TypeScript utility library to work with US cities and ZIP codes — perfect for filters, maps, address lookups, and geolocation logic.

22 lines (21 loc) 1.22 kB
import { UsCity } from "./data/types"; export declare function getStates(): import("./data/types").UsState[]; export declare function getCities(stateAbbr: string): UsCity[]; export declare function getCitiesBySateName(state: string): UsCity[]; export declare function getZipcodes(stateAbbr: string): UsCity[]; export declare function getZipcodesBySateName(state: string): UsCity[]; export declare function getCity(zip: string): UsCity | undefined; export declare function searchCities(query: string): UsCity[]; export declare function searchCitiesInSate(stateAbbr: string, query: string): UsCity[]; export declare function searchCitiesInSateByStateName(state: string, query: string): UsCity[]; export declare function groupCitiesByState(): Record<string, UsCity[]>; export declare function getAllZips(): string[]; export declare function getCitiesByCounty(county: string): UsCity[]; declare function deg2rad(value: number): number; declare function haversine(lat1: number, lon1: number, lat2: number, lon2: number): number; export declare function getNearestCity(lat: number, lon: number): UsCity | undefined; export declare const __internal__: { deg2rad: typeof deg2rad; haversine: typeof haversine; }; export {};