Giter VIP home page Giter VIP logo

geokit's Introduction

geokit

npm npm bundle size Lint and Test Coveralls github David GitHub stars GitHub forks

Full documentation is available at https://geokit.geofirestore.com.

An assortment of geolocation related tools, all packaged in one easy to use kit.

Methods

distance(start: LatLngLiteral, end: LatLngLiteral, unit?: string): number

Calculates the distance, in kilometers, between two coordinates.

start and end must be LatLngLiterals { lat: 0, lng: 0 }.

import * as geokit from 'geokit';

const start = {lat: 41.3083, lng: -72.9279};
const end = {lat: -33.8688, lng: 151.2093};

const distance = geokit.distance(location1, location2); // distance === 16082.811206563834

hash(coordinates: LatLngLiteral, precision?: number): string

Generates Geohash of coordinates.

coordinates must be LatLngLiterals { lat: 0, lng: 0 }.

import * as geokit from 'geokit';

const coordinates = {lat: 41.3083,  lng: -72.9279};

const hash = geokit.hash(coordinates); // hash === 'drk4urzw2c'

decodeHash(hash: string): LatLngLiteral

Decodes a Geohash into its Latitude and Longitude as a LatLngLiteral.

import * as geokit from 'geokit';

const hash = 'r3gx2f77b';

const coordinates = geokit.decodeHash(hash); // coordinates === {lat: -33.86881113052368,  lng: 151.2093186378479}

validateCoordinates(coordinates: LatLngLiteral): boolean

Validates coordinates and returns a boolean if valid, or throws an error if invalid.

coordinates must be LatLngLiterals { lat: 0, lng: 0 }.

import * as geokit from 'geokit';

const coordinates = {lat: 41.3083,  lng: -72.9279};

const isValid = geokit.validateCoordinates(coordinates); // true

validateHash(hash: string): LatLngLiteral

Validates a Geohash and returns a boolean if valid, or throws an error if invalid.

import * as geokit from 'geokit';

const hash = 'r3gx2f77b';

const isValid = geokit.validateHash(hash); // true

geokit's People

Contributors

michaelsolati avatar dependabot-preview[bot] avatar

Watchers

James Cloos 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.