ttl #

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

[Redis documentation]

Arguments #

ttl(key, [options]);

string

object

options #

The options arguments can contain the following option properties:

boolean (true)

Resolve #

Resolves to the remaining key TTL, in seconds, or to a negative value if the key does not exist or if it is persistent.

Usage #

try {
  await kuzzle.ms.set('foo', 'bar', {ex: 60});
  // Prints: 60
  console.log(await kuzzle.ms.ttl('foo'));
} catch (error) {
  console.error(error.message);
}