ttl #
Returns the remaining time to live of a key, in seconds, or a negative value if the key does not exist or if it is persistent.
ttl(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 |
Callback Response #
Returns an integer containing the remaining time to live of the key, in seconds.
Usage #
// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.ttl('key', function (err, ttl) {
// callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.ttlPromise('key')
.then(ttl => {
// resolved once the action has completed
});
Callback response:
42
Edit this page on Github(opens new window)