SDK Javascript v5.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

geodist #

Returns the distance between two geospatial members of a key (see geoadd). The returned distance is expressed in meters by default.

[Redis documentation] (opens new window)

geodist(key, member1, member2, [options], callback) #

Arguments Type Description
key string Key identifier
member1 string Name of the first geospatial point
member2 string Name of the second geospatial point
options JSON Object Optional parameters
callback function Callback

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true
unit string Distance unit.
Allowed values: m, km, mi, ft

Callback Response #

Returns the calculated distance between the two provided geospatial points.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.geodist('key', 'Palermo', 'Catania', function (err, distance) {
  // callback called once the action has completed
// Using promises (NodeJS only)
kuzzle.memoryStorage.geodistPromise('key', 'Palermo', 'Catania')
  .then(distance => {
    // resolved once the action has completed

Callback response:

Copied to clipboard!