SDK
SDK Javascript v5.x
1

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]


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

ArgumentsTypeDescription
keystringKey identifier
member1stringName of the first geospatial point
member2stringName of the second geospatial point
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue
unitstringDistance unit.
Allowed values: m, km, mi, ft
m

Callback Response #

Returns the calculated distance between the two provided geospatial points.

Usage #

// 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:

166274.1516