incr #
Increments the number stored at key by 1. If the key does not exist, it is set to 0 before performing the operation.
Arguments #
incr(key, [options]);| Arguments | Type | Description |
|---|---|---|
key | string | Key |
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 the incremented key value.
Usage #
try {
await kuzzle.ms.set('foo', 41);
// Prints: 42
console.log(await kuzzle.ms.incr('foo'));
} catch (error) {
console.error(error.message);
}