whasome-interview-api

1.0.1 • Public • Published

Location API

Fake Location API used for interviews

API Documentation

Data Types

POINT_OBJECT = { lat: NUMBER, lon: NUMBER }
LOCATION_OBJECT = {
    address: STRING,
    point: POINT_OBJECT
}
DATA_OBJECT = {
    name: STRING,
    practices: [LOCATION_OBJECT]
}

fetchDoctors

Fetch multiple people with location information and name

  • Input Params: None
  • Returns Promise <[DATA_OBJECT]>

getDistance

Determines distance between two coordinate object points, returns distance in miles

  • Input Params: (POINT_OBJECT, POINT_OBJECT)
  • Returns NUMBER

Example

const pointA = { lat: 38.6093425, lon: -121.5148304}
const pointB = { lat: 38.5769468, lon: -121.48017379999999 }
const distance = getDistance(pointA, pointB);
console.log(distance); // Prints 2.92

getCurrentLocation

Gets the user's current location

  • Input Params: None
  • Returns Promise <PointObject>

testSort

Returns an array of sorted doctors for testing that sort works

  • Input Params: None
  • Returns:
[
    {
        name: STRING,
        practices: [
            point: POINT_OBJECT,
            distance: NUMBER,
            address: STRING
        ]
    }
]

Readme

Keywords

none

Package Sidebar

Install

npm i whasome-interview-api

Weekly Downloads

1

Version

1.0.1

License

MIT

Last publish

Collaborators

  • jferrell