geohash #
Converts a key's geopoints (see geoadd) into geohashes.
Arguments #
geohash(key, geopoints, [options]);| Arguments | Type | Description |
|---|---|---|
key | string | Key |
geopoints | string[] | List of geopoints to convert |
options | object | Optional query arguments |
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 an array of converted geohashes, in the same order than the one provided in the query.
Usage #
const kuzzleHQ = {
lon: 3.9109057,
lat: 43.6073913,
name: 'HQ'
};
const otherHQ = {
lon: 3.897105,
lat: 43.6002203,
name: 'other HQ'
};
try {
await kuzzle.ms.geoadd('geofoo', [kuzzleHQ, otherHQ]);
// Prints: [ 'spfb0frz6x0', 'spfb09jv9n0' ]
console.log(await kuzzle.ms.geohash('geofoo', ['HQ', 'other HQ']));
} catch (error) {
console.error(error.message);
}