Update the zadd and zaddincr docs.

valkey-io · Feb 1, 2024 · ec6b768 · ec6b768
1 parent 90fde6f
commit ec6b768
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/node/src/BaseClient.ts b/node/src/BaseClient.ts
@@ -989,6 +989,7 @@ export class BaseClient {
      * @param changed - Modify the return value from the number of new elements added, to the total number of elements changed.
      * @returns The number of elements added to the sorted set.
      * If `changed` is set, returns the number of elements updated in the sorted set.
+     * If `key` holds a value that is not a sorted set, an error is returned.
      *
      * @example
      *      await zadd("mySortedSet", \{ "member1": 10.5, "member2": 8.2 \})
@@ -1025,6 +1026,7 @@ export class BaseClient {
      * @param options - The Zadd options.
      * @returns The score of the member.
      * If there was a conflict with the options, the operation aborts and null is returned.
+     * If `key` holds a value that is not a sorted set, an error is returned.
      *
      * @example
      *      await zaddIncr("mySortedSet", member , 5.0)

diff --git a/node/src/Transaction.ts b/node/src/Transaction.ts
@@ -715,6 +715,7 @@ export class BaseTransaction {
      *
      * Command Response - The number of elements added to the sorted set.
      * If `changed` is set, returns the number of elements updated in the sorted set.
+     * If `key` holds a value that is not a sorted set, an error is returned.
      */
     public zadd(
         key: string,
@@ -744,6 +745,7 @@ export class BaseTransaction {
      *
      * Command Response - The score of the member.
      * If there was a conflict with the options, the operation aborts and null is returned.
+     * If `key` holds a value that is not a sorted set, an error is returned.
      */
     public zaddIncr(
         key: string,