No results for

Powered byAlgolia
⚠️ This is the archived documentation for k6 v0.47. Go to the latest version.

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

import redis from 'k6/experimental/redis';
// Get the redis instance(s) address and password from the environment
const redis_addrs = __ENV.REDIS_ADDRS || '';
const redis_password = __ENV.REDIS_PASSWORD || '';
// Instantiate a new redis client
const redisClient = new redis.Client({
addrs: redis_addrs.split(',') || new Array('localhost:6379'), // in the form of 'host:port', separated by commas
password: redis_password,
});
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);
}