Class GeoLocationValidator

constructor

• new GeoLocationValidator(): GeoLocationValidator

• Returns GeoLocationValidator

radiusOfEarth

calculateDistanceBetweenCoordinates

• calculateDistanceBetweenCoordinates(coordinates1, coordinates2): number

• A method to calculate the distance between two geographic points based on latitude and longitude

  Parameters

  • coordinates1: Coordinates

    A object/interface containing the longitude and latitude of the point of location

  • coordinates2: Coordinates

    An object/interface containing the longitude and the latittude of the point of reference

  Returns number

  The distance between these points in meters

degree2Radian

• degree2Radian(deg): number

• Converts degrees to radians

  Parameters

  • deg: number

  Returns number

fetchCoordinatesHtml5Geolocation

• fetchCoordinatesHtml5Geolocation(): any

• Fetches coordinates using IP Geolocation API on

  Returns any

fetchIpBasedReq

• fetchIpBasedReq(req, ipDataAPIKey): Promise<Coordinates>

• Fetches the ip address of the client making the HTTP request

  Parameters

  • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

    The req object of the HTTP request

  • ipDataAPIKey: string

    Check out https://ipdata.co/

  Returns Promise<Coordinates>

  • Geographic coordinates of device based on http request to be validated on backend application

fetchIpCoordinatesClient

• fetchIpCoordinatesClient(ipDataAPIKey, abstractAPIKey): Promise<Coordinates>

• Fetches the geographic coordinates of device based on Ip

  Parameters

  • ipDataAPIKey: string

    Check out https://ipdata.co/

  • abstractAPIKey: string

    check out https://www.abstractapi.com/api/ip-geolocation-api

  Returns Promise<Coordinates>

  • Geographic coordinates of device

geoCodeAddressAzure

• geoCodeAddressAzure(address, azureMapAPIKey): Promise<Coordinates>

• using Azure Map services, a physical address can be passed to give its coordinates

  Parameters

  • address: string

    Pass in the physical address of a location to be gp

  • azureMapAPIKey: string

  Returns Promise<Coordinates>

geoCodeAddressGoogle

• geoCodeAddressGoogle(address, googleMapAPIKey): Promise<Coordinates>

• using Google Map services, a physical address can be passed to give its coordinates

  Parameters

  • address: string

    Pass in the physical address of a location to be geocoded

  • googleMapAPIKey: string

    API key of Google Geocoding API

  Returns Promise<Coordinates>

validateLocation

• validateLocation(userCoordinates, validationPoint, range): Promise<ValidationMessage>

• Validation Method to check location of device

  Parameters

  • userCoordinates: Coordinates

    Geographic coordinates of device

  • validationPoint: Coordinates

    Geographic coordinates of validation point

  • range: number

    Acceptable distance between the device and validation point in meters

  Returns Promise<ValidationMessage>

  Validation message True or false