Skip to main content

​
Arguments

​
key
string
required
The key of the hash.
​
fields
string | number | (string | number)[]
required
The field(s) to retrieve the TTL for.

​
Response

The remaining TTL in milliseconds for each field.
  • -2 if the field does not exist in the hash or if the key doesn’t exist.
  • -1 if the field exists but has no associated expiration.
For more details, see HPTTL documentation.
await redis.hset("my-key", "my-field", "my-value");
await redis.hpexpire("my-key", "my-field", 1000);
const ttl = await redis.hpttl("my-key", "my-field");

console.log(ttl); // e.g., [950]