Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 1.64 KB

README.md

File metadata and controls

74 lines (46 loc) · 1.64 KB

find-lat-lng Build Status

Finds latitude and longitude for an array of street names.

Install

$ npm install --save find-lat-lng

# or with yarn

$ yarn add find-lat-lng

Usage

import findLatLong from 'find-lat-lng';

const GOOGLE_API_KEY = 'your_google_api_key'; // (https://developers.google.com/maps/documentation/javascript/get-api-key)
const client = findLatLng(GOOGLE_API_KEY);
const items = ["Lönnrotinkatu 5, Helsinki", "Lönnrotinkatu 4, Helsinki"];

(async () => {
  const itemsWithLatLng = await client(items, { debug: false });
  console.log(itemsWithLatLng);

  /*
  [
    { address: 'Lonnrotinkatu 5', lat: 60.166924, lng: 24.939788},
    { address: 'Lonnrotinkatu 4', lat: 60.167142, lng: 24.940959},
    ...
  ]
  */
})();

If lat and/or lng is not found null is returned

API

findLatLng(GOOGLE_API_KEY)(items [,options])

findLatLng must be initialized with your Google Maps API Key. After calling the initialized client it returns a promise for an array of address, lat, lng objects.

Items must be an array of addresses to search for.

Options

Type: Object default: {debug: false}

Object of optional options.

debug

Type: Boolean default: false

If true, console.warns about lat/lngs that were not found.

CLI

See find-lat-lng-cli for a CLI for this module

Related

License

MIT © Pete Nykänen