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.

[Redis documentation]

ttl(key, [options], callback)

Arguments Type Description
key string Key identifier
options JSON Object Optional parameters
callback function Callback


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.


Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.ttl('key', function (err, ttl) {
  // callback called once the action has completed

// Using promises (NodeJS only)
  .then(ttl => {
    // resolved once the action has completed

Callback response:

Copied to clipboard!