decr #
Decrements the number stored at key
by 1. If the key does not exist, it is set to 0 before performing the operation.
Arguments #
decr(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 |
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 updated key value.
Usage #
try {
await kuzzle.ms.set('val', 43);
// Prints: 42
console.log(await kuzzle.ms.decr('val'));
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)