Hash

HPEXPIRETIME

Retrieves the expiration time of a field in a hash in milliseconds.

Arguments

keybodystringrequired

The key of the hash.

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

The field(s) to retrieve the expiration time for.

Response

integerrequired

The expiration time in milliseconds since the Unix epoch.

  • -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 HPEXPIRETIME documentation.

Example
await redis.hset("my-key", "my-field", "my-value");await redis.hpexpireat("my-key", "my-field", Date.now() + 1000);const expireTime = await redis.hpexpiretime("my-key", "my-field");console.log(expireTime); // e.g., 1697059200000
Loading search…