distance-matrix-endpoint

For when all you need is an endpoint. Creates and returns endpoint for Google Distance Matrix API.

Default output type is JSON. Default distance type is Imperial, "miles"

Installation

npm i distance-matrix-endpoint

Usage

const distanceMatrix = require('distance-matrix-endpoint')

// endpoint = (originArray, destinationArray, travelMode, apiKey, outputType = "json", unitType = "imperial")

Examples

  //origin array
  [
    ["Beaufort", "SC"]
  ],
  // Destination array
  [
    ["Savannah", "GA"],
    ["Charlotte", "NC"],
    ["Boston", "MA"]
  ],
  // Travel type
  "DRIVING",
  // Your API key
  "12345-SHIP-CANS-9876",
  //output Type
  "json",
  //distance Unit Type
  "imperial"
]

const inputEx2 = {
  originArray: [
    ["Port of Los Angeles", "CA"],
    ["Port of Long Beach", "CA"]
  ],
  destinationArray: [
    ["Torrance", "CA"],
    ["Santa Fe Springs", "CA"],
    ["Fresno", "CA"]
  ],
  travelMode: "DRIVING",
  apiKey: "12345-SHIP-CANS-9876",
  //output Type
  outputType: "XML",
  //distance Unit Type
  unitType: "imperial"
}

const inputEx3 =[
  //origin array
  [
    ["Port of Oakland", "CA"]
  ],
  // Destination array
  [
    ["Fresno", "CA"],
    ["Stockton", "CA"],
    ["Bakersfield", "CA"]
  ],
  // Travel type
  "DRIVING",
  // Your API key
  "12345-SHIP-CANS-9876",
  "json"
]

//EXAMPLE1
const example1 = distanceMatrix.endpoint(...inputEx1)
console.log(example1)
//string => https://maps.googleapis.com/maps/api/distancematrix/JSON?units=IMPERIAL&origins=BEAUFORT+SC&destinations=SAVANNAH+GA|CHARLOTTE+NC|BOSTON+MA&mode=DRIVING&key=12345-SHIP-CANS-9876

//EXAMPLE2
const xample2 = distanceMatrix.endpoint(inputEx2.originArray, inputx2.destinationArray, inputEx2.travelMode, inputEx2.apiKey, inputEx2.outputType, inputEx2.unitType)
console.log(example2)
//string => https://maps.googleapis.com/maps/api/distancematrix/XML?units=IMPERIAL&origins=PORT+OF+LOS+ANGELES+CA|PORT+OF+LONG+BEACH+CA&destinations=TORRANCE+CA|SANTA+FE+SPRINGS+CA|FRESNO+CA&mode=DRIVING&key=12345-SHIP-CANS-9876

//EXAMPLE3
const example3 = distanceMatrix.endpoint(...inputEx3)
console.log(example3)
//string => https://maps.googleapis.com/maps/api/distancematrix/JSON?units=IMPERIAL&origins=PORT+OF+OAKLAND+CA&destinations=FRESNO+CA|STOCKTON+CA|BAKERSFIELD+CA&mode=DRIVING&key=12345-SHIP-CANS-9876

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT