Hash
HPEXPIRE
Sets an expiration time for a field in a hash in milliseconds.
Arguments
keybodystringrequired
The key of the hash.
fieldsbodystring | number | (string | number)[]required
The field or list of fields within the hash to set the expiry for.
millisecondsbodynumberrequired
The time-to-live (TTL) in milliseconds.
optionbodystring
Optional condition for setting the expiration:
NX: Set the expiration only if the field does not already have an expiration.XX: Set the expiration only if the field already has an expiration.GT: Set the expiration only if the new TTL is greater than the current TTL.LT: Set the expiration only if the new TTL is less than the current TTL.
For more details, see HPEXPIRE documentation.
Response
number[]required
A list of integers indicating whether the expiry was successfully set.
-2if the field does not exist in the hash or if key doesn't exist.0if the expiration was not set due to the condition.1if the expiration was successfully set.2if called with 0 seconds/milliseconds or a past Unix time.
For more details, see HPEXPIRE documentation.
Example
await redis.hset("my-key", "my-field", "my-value");const expirationSet = await redis.hpexpire("my-key", "my-field", 1000);console.log(expirationSet); // [1]