Home / node / Commands / interfaces / HSetExOptions @valkey/valkey-glide

---

@valkey/valkey-glide / Commands / HSetExOptions

Interface: HSetExOptions

Optional arguments for the HSETEX command.

Example

// Set fields with 60 second expiration, only if none exist
const options: HSetExOptions = {
    fieldConditionalChange: HashFieldConditionalChange.ONLY_IF_NONE_EXIST,
    expiry: { type: TimeUnit.Seconds, count: 60 }
};

// Set fields and keep existing TTL
const keepTtlOptions: HSetExOptions = {
    expiry: "KEEPTTL"
};

See https://valkey.io/commands/hsetex/ for more details.

Properties

expiry?

optional expiry: HSetExExpiry

Expiry settings for the fields. See HSetExExpiry.

---

fieldConditionalChange?

optional fieldConditionalChange: HashFieldConditionalChange

Options for handling existing fields. See HashFieldConditionalChange.