Interface: HExpireOptions

Shared optional arguments for HEXPIRE, HPEXPIRE, HEXPIREAT, and HPEXPIREAT commands.

This interface provides a unified way to specify expiration conditions for hash field expiration commands that support conditional expiration setting.

Example

// Set expiration only if field has no existing expiration
const options: HExpireOptions = {
    condition: HashExpirationCondition.ONLY_IF_NO_EXPIRY
};

// Set expiration only if new expiration is greater than current
const gtOptions: HExpireOptions = {
    condition: HashExpirationCondition.ONLY_IF_GREATER_THAN_CURRENT
};

// Set expiration only if field has existing expiration
const xxOptions: HExpireOptions = {
    condition: HashExpirationCondition.ONLY_IF_HAS_EXPIRY
};

// Set expiration only if new expiration is less than current
const ltOptions: HExpireOptions = {
    condition: HashExpirationCondition.ONLY_IF_LESS_THAN_CURRENT
};

See

Properties

condition?

optional condition: HashExpirationCondition

Condition for setting expiration. Controls when the expiration should be set based on the current state of the field's expiration. See HashExpirationCondition for available options.