Unknown SDK

pttl

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

[Redis documentation]

Arguments

Copied to clipboard!
pttl(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 TTL, in milliseconds.

Usage

Copied to clipboard!
try {
  await kuzzle.ms.psetex('foo', 'bar', 60000);
  // Prints: 60000
  console.log(await kuzzle.ms.pttl('foo'));
} catch (error) {
  console.error(error.message);
}