decr #
Decrements the number stored at key
by 1. If the key does not exist, it is set to 0 before performing the operation.
decr(key, [options], [callback]) #
Arguments | Type | Description |
---|---|---|
key | string | Key identifier |
options | JSON Object | Optional parameters |
callback | function | Callback |
Options #
Option | Type | Description | Default |
---|---|---|---|
queuable | boolean | Make this request queuable or not | true |
Return Value #
Returns the MemoryStorage
object to allow chaining.
Callback Response #
Returns an integer containing the updated key value.
Usage #
// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.decr('key', function (err, value) {
// callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.decrPromise('key')
.then(value => {
// resolved once the action has completed
});
Callback response:
-1
Edit this page on Github(opens new window)