Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/experimentalbreadcrumb arrow redisbreadcrumb arrow Clientbreadcrumb arrow Client.ttl(key)
Open source

Client.ttl(key)

Returns the remaining time to live of a key that has a timeout.

Parameters

ParameterTypeDescription
keystringthe key to get the TTL of.

Returns

TypeResolves withRejected when
Promise<number>On success, the promise resolves with the TTL value in seconds.

Example

JavaScript 
import redis from 'k6/experimental/redis';

// Instantiate a new redis client
const redisClient = new redis.Client('redis://localhost:6379');

export default async function () {
  await redisClient.set('mykey', 'myvalue', 10);
  await redisClient.expire('mykey', 100);

  const ttl = await redisClient.ttl('mykey');
  if (ttl <= 10) {
    throw new Error('mykey should have a ttl of 10 <= x < 100');
  }

  await redisClient.persist('mykey', 100);
}