Interface SetOptions

interface SetOptions {
    EX?: number;
    EXAT?: number;
    GET?: boolean;
    KEEPTTL?: boolean;
    NX?: boolean;
    PX?: number;
    PXAT?: number;
    XX?: boolean;
    condition?: "IFEQ" | "IFNE" | "IFDEQ" | "IFDNE" | "NX" | "XX";
    expiration?: "KEEPTTL" | {
        type: "EX" | "PX" | "EXAT" | "PXAT";
        value: number;
    } | {
        type: "KEEPTTL";
    };
    matchValue?: RedisArgument;
}

Properties

EX? EXAT? GET? KEEPTTL? NX? PX? PXAT? XX? condition? expiration? matchValue?

Properties

Optional EX

EX?: number

Deprecated

Use expiration { type: 'EX', value: number } instead

Optional EXAT

EXAT?: number

Deprecated

Use expiration { type: 'EXAT', value: number } instead

Optional GET

GET?: boolean

Optional KEEPTTL

KEEPTTL?: boolean

Deprecated

Use expiration 'KEEPTTL' instead

Optional NX

NX?: boolean

Deprecated

Use { condition: 'NX' } instead.

Optional PX

PX?: number

Deprecated

Use expiration { type: 'PX', value: number } instead

Optional PXAT

PXAT?: number

Deprecated

Use expiration { type: 'PXAT', value: number } instead

Optional XX

XX?: boolean

Deprecated

Use { condition: 'XX' } instead.

Optional Experimental condition

condition?: "IFEQ" | "IFNE" | "IFDEQ" | "IFDNE" | "NX" | "XX"

Condition for setting the key:

  • NX - Set if key does not exist

  • XX - Set if key already exists

  • IFEQ - Set if current value equals match-value (since 8.4, requires matchValue)

  • IFNE - Set if current value does not equal match-value (since 8.4, requires matchValue)

  • IFDEQ - Set if current value digest equals match-digest (since 8.4, requires matchValue)

  • IFDNE - Set if current value digest does not equal match-digest (since 8.4, requires matchValue)

Optional expiration

expiration?: "KEEPTTL" | {
    type: "EX" | "PX" | "EXAT" | "PXAT";
    value: number;
} | {
    type: "KEEPTTL";
}

Type declaration

  • type: "EX" | "PX" | "EXAT" | "PXAT"
  • value: number

Type declaration

  • type: "KEEPTTL"

Optional matchValue

matchValue?: RedisArgument

Value or digest to compare against. Required when using IFEQ, IFNE, IFDEQ, or IFDNE conditions.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc