@blinkmobile/geolocation

wrapper for HTML5 GeoLocation

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
01Aug 23, 2017Feb 16, 2015Minified + gzip package size for @blinkmobile/geolocation in KB

Readme

geolocation.js Travis CI Status npm module

wrapper for HTML5 GeoLocation

Why?

We've noticed that different browsers (and web views) sometimes return a Position object that is incompatible with JSON.stringify(). Our wrapper fixes this problem.

Further, it also exposes a Promise API for people that prefer them.

Requirements

This library assumes ECMAScript 2015 support (including Promise). Be sure to shim these in older environments as required.

API

clonePosition(position)

  • @param {Position} position returned from GeoLocation API
  • @returns {Object} plain JavaScript object with the coordinate information
  • @throws {TypeError} if position or position.coords are not objects

getCurrentPosition(options)

  • @param {Object} [options]
  • @returns {Promise}

Promise style that is otherwise inspired by the W3C standard: http://dev.w3.org/geo/api/spec-source.html#api_description

Further Reading

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.