https://github.com/vnsmoreira/get-route

A simple utility to calculate route between addresses
https://github.com/vnsmoreira/get-route

brasil calculate-distance

Last synced: about 1 month ago
JSON representation

A simple utility to calculate route between addresses

• Host: GitHub
• URL: https://github.com/vnsmoreira/get-route
• Owner: vnsmoreira
• License: mit
• Created: 2022-01-11T09:05:54.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-06T12:17:28.000Z (11 months ago)
• Last Synced: 2024-07-10T16:01:18.491Z (5 months ago)
• Topics: brasil, calculate-distance
• Language: JavaScript
• Homepage:
• Size: 137 KB
• Stars: 441
• Watchers: 3
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starts - vnsmoreira/get-route - A simple utility to calculate route between addresses (others)

README

        


A simple utility to calculate route between addresses.





> :warning: Not compatible with Browsers due to CORS Policy.

## Installation

    npm i get-route

## How to use

````javascript

import getRoute from 'get-route';

...

const origin = 'Cupecê, 3958';

const destination = '04335-000';

const response = await getRoute(origin, destination);

console.log(response);

````

### Response 

````javascript

{

  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                                      |