geoadd #

Adds geospatial points to the specified key.

Arguments #

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
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolve #

Resolves to the number of points added.

Usage #

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);
}

Edit this page on Github