Hash

HPTTL

Retrieves the remaining time-to-live (TTL) for field(s) in a hash in milliseconds.

Arguments

keybodystringrequired

The key of the hash.

fieldsbodystring | number | (string | number)[]required

The field(s) to retrieve the TTL for.

Response

number[]required

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.

Example
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]
Loading search…