expo-osm-sdk
Version:
OpenStreetMap component for React Native with Expo
41 lines • 1.57 kB
TypeScript
import { NominatimSearchOptions, NominatimReverseOptions, SearchLocation, Coordinate } from '../types';
/**
* Search for locations using a text query
*
* @param query - Search text (e.g., "New York", "Starbucks near London")
* @param options - Search options
* @returns Promise<SearchLocation[]>
*/
export declare const searchLocations: (query: string, options?: NominatimSearchOptions) => Promise<SearchLocation[]>;
/**
* Reverse geocoding - get location details from coordinates
*
* @param coordinate - Latitude and longitude
* @param options - Reverse geocoding options
* @returns Promise<SearchLocation | null>
*/
export declare const reverseGeocode: (coordinate: Coordinate, options?: NominatimReverseOptions) => Promise<SearchLocation | null>;
/**
* Get suggestions for a partial query (for autocomplete)
*
* @param query - Partial search text
* @param options - Search options
* @returns Promise<SearchLocation[]>
*/
export declare const getSuggestions: (query: string, options?: NominatimSearchOptions) => Promise<SearchLocation[]>;
/**
* Calculate distance between two coordinates (Haversine formula)
*
* @param coord1 - First coordinate
* @param coord2 - Second coordinate
* @returns Distance in kilometers
*/
export declare const calculateDistance: (coord1: Coordinate, coord2: Coordinate) => number;
/**
* Format distance for display
*
* @param distanceKm - Distance in kilometers
* @returns Formatted distance string
*/
export declare const formatDistance: (distanceKm: number) => string;
//# sourceMappingURL=nominatim.d.ts.map