forked from nchaulet/node-geocoder
/
index.d.ts
136 lines (118 loc) · 3.55 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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
// Type definitions for node-geocoder 3.24
// Project: https://github.com/nchaulet/node-geocoder#readme
// Definitions by: Krzysztof Rosinski <https://github.com/rosek86>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference types="node" />
declare namespace node_geocoder {
type Providers =
'freegeoip' | 'datasciencetoolkit' |
'locationiq' | 'mapquest' | 'openmapquest' |
'tomtom' | 'nominatimmapquest' |
'opencage' | 'geocodio' |
'yandex' | 'teleport' | 'pickpoint' | 'here';
interface BaseOptions {
provider: Providers;
httpAdapter?: 'https' | 'http' | 'request';
timeout?: number;
formatterPattern?: string;
formatter?: any;
}
interface HereOptions {
provider: 'here';
apiKey: string;
language?: string;
politicalView?: string;
country?: string;
state?: string;
production?: boolean;
}
interface OpenStreetMapOptions {
provider: 'openstreetmap';
language?: string;
email?: string;
apiKey?: string;
osmServer?: string;
}
interface OpenDataFranceOptions {
provider: 'opendatafrance';
language?: string;
email?: string;
apiKey?: string;
}
interface AgolOptions {
provider: 'agol';
client_id?: string;
client_secret?: string;
}
interface SmartyStreetsOptions {
provider: 'smartyStreet';
auth_id: string;
auth_token: string;
}
interface GoogleOptions {
provider: 'google';
clientId?: string;
apiKey?: string;
language?: string;
region?: string;
excludePartialMatches?: boolean;
channel?: string;
}
interface GenericOptions {
provider: Providers;
apiKey?: string;
language?: string;
host?: string;
}
type Options = BaseOptions & (GenericOptions | HereOptions | OpenStreetMapOptions | OpenDataFranceOptions | AgolOptions | SmartyStreetsOptions | GoogleOptions);
interface Location {
lat: number;
lon: number;
}
interface Entry {
formattedAddress?: string;
latitude?: number;
longitude?: number;
extra?: {
googlePlaceId?: string;
confidence?: number;
};
administrativeLevels?: {
level1long?: string;
level1short?: string;
level2long?: string;
level2short?: string;
};
city?: string;
streetName?: string;
streetNumber?: string;
country?: string;
countryCode?: string;
zipcode?: string;
provider?: string;
state?: string;
stateCode?: string;
county?: string;
district?: string;
building?: string;
}
interface Query {
address?: string;
country?: string;
countryCode?: string;
zipcode?: string;
minConfidence?: number;
limit?: number;
}
interface BatchResult {
error: any;
value: Entry[];
}
class Geocoder {
geocode(query: string | Query, cb?: (err: any, data: Entry[]) => void): Promise<Entry[]>;
batchGeocode(queries: string[] | Query[], cb?: (err: any, data: BatchResult[]) => void): Promise<BatchResult[]>;
reverse(loc: Location, cb?: (err: any, data: Entry[]) => void): Promise<Entry[]>;
}
}
declare function node_geocoder(options: node_geocoder.Options): node_geocoder.Geocoder;
export = node_geocoder;