geo-city-finder
Version:
A lightweight JavaScript library for identifying cities based on geographical coordinates and determining if provided coordinates match those of a city with high accuracy.
22 lines (21 loc) • 778 B
TypeScript
/**
* Represents a location with latitude, longitude, and accuracy.
*
* @interface ILocation
* @property {number} accuracy - The accuracy of the location.
* @property {number} latitude - The latitude of the location.
* @property {number} longitude - The longitude of the location.
*/
interface ILocation {
accuracy: number;
latitude: number;
longitude: number;
}
/**
* Retrieves the match of coordinates.
*
* @param {ILocation} coordinates - The coordinates to match.
* @return {Promise<boolean | undefined>} A promise that resolves to a boolean indicating whether the coordinates match or undefined if there was an error.
*/
declare function getCoordinatesMatch(coordinates: ILocation): Promise<boolean | undefined>;
export default getCoordinatesMatch;