Javascript 7.x

geohash

Converts a key's geopoints (see geoadd) into geohashes.

[Redis documentation]

Arguments

Copied to clipboard!
geohash(key, geopoints, [options]);

Arguments Type Description
key
string
Key
geopoints
string[]
List of geopoints to convert
options
object
Optional query arguments

options

The options arguments can contain the following option properties:

Property Type (default) Description
queuable
boolean (true)
If true, queues the request during downtime, until connected to Kuzzle again

Resolve

Resolves to an array of converted geohashes, in the same order than the one provided in the query.

Usage

Copied to clipboard!
const kuzzleHQ = {
  lon: 3.9109057,
  lat: 43.6073913,
  name: 'HQ'
};
const otherHQ = {
  lon: 3.897105,
  lat: 43.6002203,
  name: 'other HQ'
};
try {
  await kuzzle.ms.geoadd('geofoo', [kuzzleHQ, otherHQ]);
  // Prints: [ 'spfb0frz6x0', 'spfb09jv9n0' ]
  console.log(await kuzzle.ms.geohash('geofoo', ['HQ', 'other HQ']));
} catch (error) {
  console.error(error.message);
}