Skip to content

Commit f62dce2

Browse files
elchukcMiniCodeMonkey
authored andcommitted
narrow input types to only expected properties
1 parent 4a66858 commit f62dce2

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

lib/index.d.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ declare module 'geocodio-library-node' {
1717
postal_code?: string; // Alternative to zip used in some API calls
1818
}
1919

20+
export type AddressInputComponents = Pick<AddressComponents, "street" | "city" | "county" | "state" | "postal_code" | "country">
21+
2022
export type GeocodeAccuracyType =
2123
| 'rooftop'
2224
| 'point'
@@ -259,8 +261,8 @@ declare module 'geocodio-library-node' {
259261
export default class Geocodio {
260262
constructor(apiKey?: string, hostname?: string, apiVersion?: string);
261263

262-
geocode(query: string | AddressComponents, fields?: FieldOption[], limit?: number): Promise<SingleGeocodeResponse>;
263-
geocode(query: (string | AddressComponents)[] | Record<string, string | AddressComponents>, fields?: FieldOption[], limit?: number): Promise<BatchGeocodeResponse>;
264+
geocode(query: string | AddressInputComponents, fields?: FieldOption[], limit?: number): Promise<SingleGeocodeResponse>;
265+
geocode(query: (string | AddressInputComponents)[] | Record<string, string | AddressInputComponents>, fields?: FieldOption[], limit?: number): Promise<BatchGeocodeResponse>;
264266

265267
reverse(query: string | [number, number], fields?: FieldOption[], limit?: number): Promise<ReverseGeocodeResponse>;
266268
reverse(query: (string | [number, number])[] | Record<string, string | [number, number]>, fields?: FieldOption[], limit?: number): Promise<BatchReverseGeocodeResponse>;

0 commit comments

Comments
 (0)