SDK
SDK Javascript v5.x
1

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.

pttl #

Returns the remaining time to live of a key, in milliseconds.

[Redis documentation]


pttl(key, [options], callback) #

ArgumentsTypeDescription
keystringKey identifier
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Callback Response #

Returns an integer containing the remaining time to live of the key, in milliseconds.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.pttl('key', function (err, ttl) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.pttlPromise('key')
  .then(ttl => {
    // resolved once the action has completed
  });

Callback response:

43159