geohashes-between

Get a list of geohashes between two geohashes, or between two coordinates.

Installation

Using npm, npm i geohashes-between.

Using yarn, yarn add geohashes-between.

Usage

Using import

import { getGeohashesBetweenTwoGeohashes } from 'geohashes-between';

In a CommonJS environment

const { getGeohashesBetweenTwoGeohashes } = require('geohashes-between');

Then:

const list = getGeohashesBetweenTwoGeohashes('ezep', 'ezex');
// list is ['ezer']

Or:

const pointA = [-3.684166, 40.416763];
const pointB = [-3.720741, 40.364335];

const list = getGeohashesBetweenCoordinates(pointA, pointB, 6);
// list is ['ezjmuj', 'ezjmuh','ezjmu5', 'ezjmgg','ezjmgf', 'ezjmgc','ezjmgb', 'ezjmg8','ezjmex', 'ezjmew','ezjmeq', 'ezjmem','ezjmek']

Table of contents

Functions

• getBBoxRingGeohashes
• getGeohashesBetweenCoordinates
• getGeohashesBetweenTwoGeohashes

Functions

getBBoxRingGeohashes

▸ getBBoxRingGeohashes(bbox, precision): string[]

Find the geohashes of a given precision that form a BBox ring

Parameters

| Name | Type | Description | | :---------- | :------- | :---------------------------------- | | bbox | BBox | The BBox to find the ring geohashes | | precision | number | Precision for the geohashes |

Returns

string[]

Geohashes list

getGeohashesBetweenCoordinates

▸ getGeohashesBetweenCoordinates(pointA, pointB, precision): string[]

Finds the geohashes of a given precision between two coordinates

export

Parameters

| Name | Type | Description | | :---------- | :--------- | :----------------------------- | | pointA | Position | Starting coordinate [lon, lat] | | pointB | Position | End coordinate [lon, lat] | | precision | number | Desired geohash precision |

Returns

string[]

The list of geohashes between those coords

getGeohashesBetweenTwoGeohashes

▸ getGeohashesBetweenTwoGeohashes(geohashStart, geohashEnd, includeStartEnd?): string[]

Gets a list of geohashes between a starting and end geohash Both geohashes should be of the same precision

export

Parameters

| Name | Type | Default value | Description | | :---------------- | :-------- | :------------ | :------------------- | | geohashStart | string | undefined | The starting geohash | | geohashEnd | string | undefined | The ending geohash | | includeStartEnd | boolean | false | - |

Returns

string[]

The list of geohashes between start and end