universal-geocoder
Version:
Universal geocoding abstraction server-side and client-side with multiple built-in providers
23 lines • 1.65 kB
TypeScript
import { ExternalLoaderBody, ExternalLoaderHeaders, ExternalLoaderParams } from "../ExternalLoader";
import Geocoded from "../Geocoded";
import { GeocodeQuery, GeocodeQueryObject, ReverseQuery, ReverseQueryObject } from "../query";
import { ResponseError } from "../error";
export declare const DEFAULT_RESULT_LIMIT = 5;
export interface ProviderOptionsInterface {
readonly useSsl?: boolean;
readonly useJsonp?: boolean;
readonly apiKey?: string;
}
export declare const defaultProviderOptions: ProviderOptionsInterface;
export declare type GeocodedResultsCallback<G extends Geocoded> = (results: G[]) => void;
export declare type ErrorCallback = (responseError: ResponseError) => void;
export default interface ProviderInterface<G extends Geocoded> {
geocode(query: string | GeocodeQuery | GeocodeQueryObject): Promise<G[]>;
geocode(query: string | GeocodeQuery | GeocodeQueryObject, callback: GeocodedResultsCallback<G>, errorCallback?: ErrorCallback): void;
geodecode(query: ReverseQuery | ReverseQueryObject): Promise<G[]>;
geodecode(query: ReverseQuery | ReverseQueryObject, callback: GeocodedResultsCallback<G>, errorCallback?: ErrorCallback): void;
geodecode(latitude: number | string, longitude: number | string): Promise<Geocoded[]>;
geodecode(latitude: number | string, longitude: number | string, callback: GeocodedResultsCallback<G>, errorCallback?: ErrorCallback): void;
executeRequest(params: ExternalLoaderParams, callback: GeocodedResultsCallback<G>, headers?: ExternalLoaderHeaders, body?: ExternalLoaderBody, errorCallback?: ErrorCallback): void;
}
//# sourceMappingURL=ProviderInterface.d.ts.map