2.0.1 • Published 2 years ago
get-route v2.0.1
:warning: Not compatible with Browsers due to CORS Policy.
Installation
npm i get-routeHow to use
import getRoute from 'get-route';
...
const origin = 'Cupecê, 3958';
const destination = '04335-000';
const response = await getRoute(origin, destination);
console.log(response);Response
{
ok: true,
distance: '2,0 km',
distanceRaw: 1993,
time: '8 min',
timeRaw: 454,
origin: 'Av. Cupecê, 3958 - Jardim Prudência',
destination: '04335-000'
}Specifications
Arguments
| argument | required | default | type |
|---|---|---|---|
| origin | true | none | string |
| destination | true | none | string |
Response
| property | type | explanation |
|---|---|---|
| ok | boolean | success status |
| distance | string | formatted distance (in kilometers). e.g.: "5,5 km" |
| distanceRaw | number | distance in meters. e.g.: 5497 |
| time | string | formatted time (in minutes/hours/days). e.g.: "17 min" |
| timeRaw | number | time in seconds. e.g.: 1049 |
| origin | string | found origin |
| destination | string | found destination |