Upstash Documentation

HPEXPIRE

Sets an expiration time for a field in a hash in milliseconds.
1 min read

Arguments#

keystringrequired#

The key of the hash.

fieldsstring | number | (string | number)[]required#

The field or list of fields within the hash to set the expiry for.

millisecondsnumberrequired#

The time-to-live (TTL) in milliseconds.

optionstring#

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#

HPERSISTHPEXPIREAT