SDK Javascript v5.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

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.

[Redis documentation] (opens new window)

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 #

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!