forked from kevinroberts/city-timezones
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
33 lines (31 loc) · 1.01 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
declare module 'city-timezones' {
interface CityData {
readonly lat: number;
readonly lng: number;
readonly pop: number;
readonly city: string;
readonly iso2: string;
readonly iso3: string;
readonly country: string;
readonly timezone: string;
readonly province: string;
readonly exactCity: string;
readonly city_ascii: string;
readonly state_ansi: string;
readonly exactProvince: string;
}
/**
* Search for city info by searching by city name.
*
* @param input City name.
* @returns All the matching cities from search criteria.
*/
export function lookupViaCity(input: string): CityData[];
/**
* Search for city info by searching a state or province name I.E. Springfield MO
*
* @param input State or province name.
* @returns All the matching cities from search criteria.
*/
export function findFromCityStateProvince(input: string): CityData[];
}