Code Monkey home page Code Monkey logo

googleaddressdetector's Introduction

Google geocode address detector

FEATURES

  • Get formatted addresses and address parts
  • Uses promises
  • Has predefined presets for most common "smart validation" uses

Dependencies:

jQuery 3+ or axios

Roadmap:

  • Add dependency injection of ajax service
  • Switch to google autocomplete api - optional (better place predictions)
  • Add unit tests :D
  • Add build to the repo

API

Start:

import GoogleDetector from './GoogleDetectorAxios';

const detector = new GoogleDetector( options );

Options:

let options = {
    language: String,
    region: String,
    apiKey: String,
    dev: Boolean
}

Where language and region are ISO codes for countries (language of results and region where results will be filtered by), fe: DE

apiKey is google key, needed for production (only https AFAIK), no need in dev

dev logs errors with api

Methods:

getResults(query) gets raw results from google api based on query

getFormatedResults(query) gets formatted results in {formattedResult} object (see below)

getFormattedAddres(rawResult) gets formatted addres based on single raw result from api

getCityByPostalCode(postalCode) gets city name from postal code provided

getPostalCodeByFullStreet gets postal code by street + street number string (first matched)

getCorectStreetName gets street name based on street name - if google has corrected it, else - null

formattedResult object

It's object returned by getFromattedResults and getFormattedAddress methods.

Format is:

{
    full: String,
    street: String,
    city: String,
    streetNumber: String,
    postalCode: String
}

Where full is formatted, full address ('Zabłocie 25, 30-701 Kraków Polska), and rest of keys are strings with address parts, if any. Alse, the key doesn't exist

googleaddressdetector's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.