SDK
SDK Javascript v6.x
1

# geoadd

Adds geospatial points to the specified key.

[Redis documentation]

# Arguments

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

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

# geopoints

List of objects, each one of those being a geopoint to be added, with the following properties:

Properties Type Description
lat
number
Latitude
lon
number
Longitude
name
string
Unique point name (used as an identifier)

# 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 the number of points added.

# 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 {
  const result = await kuzzle.ms.geoadd('geofoo', [kuzzleHQ, otherHQ]);
  // Prints: 2
  console.log(result);
} catch (error) {
  console.error(error.message);
}