ZADD

Add a member to a sorted set, or update its score if it already exists.

Arguments

key · string · required

The key of the sorted set.

options

xx · boolean

Only update elements that already exist. Never add elements.

xx · boolean

Only add new elements. Never update elements.

ch · boolean

Return the number of elements added or updated.

incr · boolean

When this option is specified ZADD acts like ZINCRBY. Only one score-element pair can be specified in this mode.

Response

The number of elements added to the sorted sets, not including elements already existing for which the score was updated.

If ch was specified, the number of elements that were updated.

If incr was specified, the new score of member.

Simple

await redis.zadd(
    "key", 
    { score: 2, member: "member" }, 
    { score: 3, member: "member2"},
);

await redis.zadd(
    "key",
    { xx: true },
    { score: 2, member: "member" },
)

await redis.zadd(
    "key",
    { nx: true },
    { score: 2, member: "member" },
)

await redis.zadd(
    "key",
    { ch: true },
    { score: 2, member: "member" },
)

await redis.zadd(
    "key",
    { cincrh: true },
    { score: 2, member: "member" },
)