georadius #

Callback response, with no option provided:

[{ "name": "Palermo" }, { "name": "Catania" }]

Callback response, with the "withcoord" option:

[
  { "name": "Palermo", "coordinates": [13.361389338970184, 38.1155563954963] },
  { "name": "Catania", "coordinates": [15.087267458438873, 37.50266842333162] }
]

Callback response, with the "withdist" option:

[
  { "name": "Palermo", "distance": 190.4424 },
  { "name": "Catania", "distance": 56.4413 }
]

Returns the members (added with geoadd) of a given key inside the provided geospatial radius.

[Redis documentation]

georadius(key, longitude, latitude, distance, unit, [options], callback) #

Arguments	Type	Description
`key`	string	Key identifier
`longitude`	double	Longitude of the center of the radius
`latitude`	double	Latitude of the center of the radius
`distance`	double	Maximum distance from the center
`unit`	string	Distance unit
`options`	JSON Object	Optional parameters
`callback`	function	Callback

Options #

Option	Type	Description	Default
`count`	int	Limit the result set to `count` members	`null`
`queuable`	boolean	Make this request queuable or not	`true`
`sort`	string	Return items from the nearest to the farthest to the center (`ASC`) or vice versa (`DESC`)	`null`
`withcoord`	boolean	Also return the longitude and latitude coordinates of the matching items	`false`
`withdist`	boolean	Also return the distance of the returned items from the specified center, in the same unit than the one provided with `unit`	`false`

Callback Response #

Returns an array of names for points that are inside the provided radius.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.georadius('key', 15, 37, 200, 'km', function (err, points) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.georadiusPromise('key', 15, 37, 200, 'km')
  .then(points => {
    // resolved once the action has completed
  });

Edit this page on Github