Javascript 7.x

ttl

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

[Redis documentation]

Arguments

Copied to clipboard!
ttl(key, [options]);

Arguments Type Description
key
string
Key
options
object
Optional query arguments

options

The options arguments can contain the following option properties:

Property Type (default) Description
queuable
boolean (true)
If true, queues the request during downtime, until connected to Kuzzle again

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

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