Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

vnsmoreira/get-route

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

92 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A simple utility to calculate route between addresses.

⚠️ Not compatible with Browsers due to CORS Policy.

Installation

npm i get-route

How 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

About

A simple utility to calculate route between addresses

Topics

Resources

License

Stars

Watchers

Forks

Morty Proxy This is a proxified and sanitized view of the page, visit original site.