@valkey/valkey-glide 1.3.4 → 1.3.5-rc2

package/build-ts/{src/server-modules → server-modules}/GlideJson.d.ts

@@ -2,8 +2,8 @@
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
  */
 import { BaseClient, DecoderOption, GlideString } from "../BaseClient";
+import { Batch, ClusterBatch } from "../Batch";
 import { ConditionalChange } from "../Commands";
-import { ClusterTransaction, Transaction } from "../Transaction";
 export type ReturnTypeJson<T> = T | (T | null)[];
 export type UniversalReturnTypeJson<T> = T | T[];
 /**
@@ -829,12 +829,12 @@ export declare class GlideJson {
     } & DecoderOption): Promise<ReturnTypeJson<GlideString[]>>;
 }
 /**
- * Transaction implementation for JSON module. Transactions allow the execution of a group of
- * commands in a single step. See {@link Transaction} and {@link ClusterTransaction}.
+ * Batch implementation for JSON module. Batches allow the execution of a group of
+ * commands in a single step. See {@link Batch} and {@link ClusterBatch}.
  *
  * @example
  * ```typescript
- * const transaction = new Transaction();
+ * const transaction = new Batch(true);
  * JsonBatch.set(transaction, "doc", ".", '{"a": 1.0, "b": 2}');
  * JsonBatch.get(transaction, "doc");
  * const result = await client.exec(transaction);
@@ -847,7 +847,7 @@ export declare class JsonBatch {
     /**
      * Sets the JSON value at the specified `path` stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param path - Represents the path within the JSON document where the value will be set.
      *      The key will be modified only if `value` is added as the last child in the specified `path`, or if the specified `path` acts as the parent of a new child being added.
@@ -859,13 +859,13 @@ export declare class JsonBatch {
      * Command Response - If the value is successfully set, returns `"OK"`.
      *       If `value` isn't set because of `conditionalChange`, returns `null`.
      */
-    static set(transaction: Transaction | ClusterTransaction, key: GlideString, path: GlideString, value: GlideString, options?: {
+    static set(batch: Batch | ClusterBatch, key: GlideString, path: GlideString, value: GlideString, options?: {
         conditionalChange: ConditionalChange;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Retrieves the JSON value at the specified `paths` stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) Additional parameters:
      * - (Optional) Options for formatting the byte representation of the JSON data. See {@link JsonGetOptions}.
@@ -884,11 +884,11 @@ export declare class JsonBatch {
      *         Returns a stringified JSON object in bytes, in which each path is a key, and it's corresponding value, is the value as if the path was executed in the command as a single path.
      * In case of multiple paths, and `paths` are a mix of both JSONPath and legacy path, the command behaves as if all are JSONPath paths.
      */
-    static get(transaction: Transaction | ClusterTransaction, key: GlideString, options?: JsonGetOptions): Transaction | ClusterTransaction;
+    static get(batch: Batch | ClusterBatch, key: GlideString, options?: JsonGetOptions): Batch | ClusterBatch;
     /**
      * Retrieves the JSON values at the specified `path` stored at multiple `keys`.
      *
-     * @remarks When in cluster mode, all keys in the transaction must be mapped to the same slot.
+     * @remarks When in cluster mode, all keys in the batch must be mapped to the same slot.
      *
      * @param client - The client to execute the command.
      * @param keys - The keys of the JSON documents.
@@ -903,12 +903,12 @@ export declare class JsonBatch {
      *       the corresponding array element will be `null`.
      * - If a `key` doesn't exist, the corresponding array element will be `null`.
      */
-    static mget(transaction: Transaction | ClusterTransaction, keys: GlideString[], path: GlideString): Transaction | ClusterTransaction;
+    static mget(batch: Batch | ClusterBatch, keys: GlideString[], path: GlideString): Batch | ClusterBatch;
     /**
      * Inserts one or more values into the array at the specified `path` within the JSON
      * document stored at `key`, before the given `index`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param path - The path within the JSON document.
      * @param index - The array index before which values are inserted.
@@ -927,11 +927,11 @@ export declare class JsonBatch {
      *       exist or the value at `path` is not an array, an error is raised.
      * - If the index is out of bounds or `key` doesn't exist, an error is raised.
      */
-    static arrinsert(transaction: Transaction | ClusterTransaction, key: GlideString, path: GlideString, index: number, values: GlideString[]): Transaction | ClusterTransaction;
+    static arrinsert(batch: Batch | ClusterBatch, key: GlideString, path: GlideString, index: number, values: GlideString[]): Batch | ClusterBatch;
     /**
      * Pops an element from the array located at `path` in the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) See {@link JsonArrPopOptions}.
      *
@@ -947,11 +947,11 @@ export declare class JsonBatch {
      *       exist or the value at `path` is not an array, an error is raised.
      * - If the index is out of bounds or `key` doesn't exist, an error is raised.
      */
-    static arrpop(transaction: Transaction | ClusterTransaction, key: GlideString, options?: JsonArrPopOptions): Transaction | ClusterTransaction;
+    static arrpop(batch: Batch | ClusterBatch, key: GlideString, options?: JsonArrPopOptions): Batch | ClusterBatch;
     /**
      * Retrieves the length of the array at the specified `path` within the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) Additional parameters:
      * - (Optional) `path`: The path within the JSON document. Defaults to the root (`"."`) if not specified.
@@ -968,16 +968,16 @@ export declare class JsonBatch {
      *       exist or the value at `path` is not an array, an error is raised.
      * - If the index is out of bounds or `key` doesn't exist, an error is raised.
      */
-    static arrlen(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static arrlen(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Trims an array at the specified `path` within the JSON document stored at `key` so that it becomes a subarray [start, end], both inclusive.
      * If `start` < 0, it is treated as 0.
      * If `end` >= size (size of the array), it is treated as size-1.
      * If `start` >= size or `start` > `end`, the array is emptied and 0 is returned.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param path - The path within the JSON document.
      * @param start - The start index, inclusive.
@@ -997,13 +997,13 @@ export declare class JsonBatch {
      *       - If `path` doesn't exist, or the value at `path` is not an array, an error is raised.
      *       - If an index argument is out of bounds, an error is raised.
      */
-    static arrtrim(transaction: Transaction | ClusterTransaction, key: GlideString, path: GlideString, start: number, end: number): Transaction | ClusterTransaction;
+    static arrtrim(batch: Batch | ClusterBatch, key: GlideString, path: GlideString, start: number, end: number): Batch | ClusterBatch;
     /**
      * Searches for the first occurrence of a `scalar` JSON value in the arrays at the `path`.
      * Out of range errors are treated by rounding the index to the array's `start` and `end.
      * If `start` > `end`, return `-1` (not found).
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param path - The path within the JSON document.
      * @param scalar - The scalar value to search for.
@@ -1020,14 +1020,14 @@ export declare class JsonBatch {
      *       Returns an integer representing the index of matching element, or `-1` if
      *       not found. If the value at the `path` is not an array, an error is raised.
      */
-    static arrindex(transaction: Transaction | ClusterTransaction, key: GlideString, path: GlideString, scalar: GlideString | number | boolean | null, options?: {
+    static arrindex(batch: Batch | ClusterBatch, key: GlideString, path: GlideString, scalar: GlideString | number | boolean | null, options?: {
         start: number;
         end?: number;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Toggles a Boolean value stored at the specified `path` within the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) Additional parameters:
      * - (Optional) `path`: The path within the JSON document. Defaults to the root (`"."`) if not specified.
@@ -1037,40 +1037,40 @@ export declare class JsonBatch {
      * - For legacy path (`path` doesn't starts with `$`), returns the value of the toggled boolean in `path`.
      * - Note that when sending legacy path syntax, If `path` doesn't exist or the value at `path` isn't a boolean, an error is raised.
      */
-    static toggle(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static toggle(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Deletes the JSON value at the specified `path` within the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) Additional parameters:
      * - (Optional) `path`: If `null`, deletes the entire JSON document at `key`.
      *
      * Command Response - The number of elements removed. If `key` or `path` doesn't exist, returns 0.
      */
-    static del(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static del(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Deletes the JSON value at the specified `path` within the JSON document stored at `key`. This command is
      * an alias of {@link del}.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) Additional parameters:
      * - (Optional) `path`: If `null`, deletes the entire JSON document at `key`.
      *
      * Command Response - The number of elements removed. If `key` or `path` doesn't exist, returns 0.
      */
-    static forget(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static forget(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Reports the type of values at the given path.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) Additional parameters:
      * - (Optional) `path`: Defaults to root (`"."`) if not provided.
@@ -1086,14 +1086,14 @@ export declare class JsonBatch {
      *       - `null` if the document key does not exist.
      *       - `null` if the JSON path is invalid or does not exist.
      */
-    static type(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static type(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Clears arrays or objects at the specified JSON path in the document stored at `key`.
      * Numeric values are set to `0`, boolean values are set to `false`, and string values are converted to empty strings.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) Additional parameters:
      * - (Optional) `path`: The JSON path to the arrays or objects to be cleared. Defaults to root if not provided.
@@ -1103,9 +1103,9 @@ export declare class JsonBatch {
      * If `path` doesn't exist, or the value at `path` is already empty (e.g., an empty array, object, or string), `0` is returned.
      * If `key doesn't exist, an error is raised.
      */
-    static clear(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static clear(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Retrieve the JSON value at the specified `path` within the JSON document stored at `key`.
      * The returning result is in the Valkey or Redis OSS Serialization Protocol (RESP).
@@ -1117,7 +1117,7 @@ export declare class JsonBatch {
      * - JSON arrays are represented as RESP arrays, where the first element is the simple string [, followed by the array's elements.
      * - JSON objects are represented as RESP object, where the first element is the simple string {, followed by key-value pairs, each of which is a RESP bulk string.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) Additional parameters:
      * - (Optional) `path`: The path within the JSON document, defaults to root (`"."`) if not provided.
@@ -1131,14 +1131,14 @@ export declare class JsonBatch {
      *         If multiple paths match, the value of the first JSON value match is returned. If `path` doesn't exist, an error is raised.
      *     - If `key` doesn't exist, `null` is returned.
      */
-    static resp(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static resp(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Returns the length of the JSON string value stored at the specified `path` within
      * the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) Additional parameters:
      * - (Optional) `path`: The path within the JSON document, Defaults to root (`"."`) if not provided.
@@ -1154,13 +1154,13 @@ export declare class JsonBatch {
      *       - If the JSON value at`path` is not a string or if `path` doesn't exist, an error is raised.
      *     - If `key` doesn't exist, `null` is returned.
      */
-    static strlen(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static strlen(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Appends the specified `value` to the string stored at the specified `path` within the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param value - The value to append to the string. Must be wrapped with single quotes. For example, to append "foo", pass '"foo"'.
      * @param options - (Optional) Additional parameters:
@@ -1177,14 +1177,14 @@ export declare class JsonBatch {
      *       - If the JSON value at `path` is not a string of if `path` doesn't exist, an error is raised.
      *       - If `key` doesn't exist, an error is raised.
      */
-    static strappend(transaction: Transaction | ClusterTransaction, key: GlideString, value: GlideString, options?: {
+    static strappend(batch: Batch | ClusterBatch, key: GlideString, value: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Appends one or more `values` to the JSON array at the specified `path` within the JSON
      * document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param path - The path within the JSON document.
      * @param values - The JSON values to be appended to the array.
@@ -1202,11 +1202,11 @@ export declare class JsonBatch {
      *       exist or the value at `path` is not an array, an error is raised.
      * - If the index is out of bounds or `key` doesn't exist, an error is raised.
      */
-    static arrappend(transaction: Transaction | ClusterTransaction, key: GlideString, path: GlideString, values: GlideString[]): Transaction | ClusterTransaction;
+    static arrappend(batch: Batch | ClusterBatch, key: GlideString, path: GlideString, values: GlideString[]): Batch | ClusterBatch;
     /**
      * Reports memory usage in bytes of a JSON object at the specified `path` within the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param value - The value to append to the string. Must be wrapped with single quotes. For example, to append "foo", pass '"foo"'.
      * @param options - (Optional) Additional parameters:
@@ -1221,13 +1221,13 @@ export declare class JsonBatch {
      *         returns the data of the first matching object. If `path` doesn't exist, an error is raised.
      *     - If `key` doesn't exist, returns `null`.
      */
-    static debugMemory(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static debugMemory(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Reports the number of fields at the specified `path` within the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param value - The value to append to the string. Must be wrapped with single quotes. For example, to append "foo", pass '"foo"'.
      * @param options - (Optional) Additional parameters:
@@ -1242,13 +1242,13 @@ export declare class JsonBatch {
      *         returns the data of the first matching object. If `path` doesn't exist, an error is raised.
      *     - If `key` doesn't exist, returns `null`.
      */
-    static debugFields(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static debugFields(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Increments or decrements the JSON value(s) at the specified `path` by `number` within the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param path - The path within the JSON document.
      * @param num - The number to increment or decrement by.
@@ -1265,11 +1265,11 @@ export declare class JsonBatch {
      *     - If `key` does not exist, an error is raised.
      *     - If the result is out of the range of 64-bit IEEE double, an error is raised.
      */
-    static numincrby(transaction: Transaction | ClusterTransaction, key: GlideString, path: GlideString, num: number): Transaction | ClusterTransaction;
+    static numincrby(batch: Batch | ClusterBatch, key: GlideString, path: GlideString, num: number): Batch | ClusterBatch;
     /**
      * Multiplies the JSON value(s) at the specified `path` by `number` within the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param path - The path within the JSON document.
      * @param num - The number to multiply by.
@@ -1286,11 +1286,11 @@ export declare class JsonBatch {
      *     - If `key` does not exist, an error is raised.
      *     - If the result is out of the range of 64-bit IEEE double, an error is raised.
      */
-    static nummultby(transaction: Transaction | ClusterTransaction, key: GlideString, path: GlideString, num: number): Transaction | ClusterTransaction;
+    static nummultby(batch: Batch | ClusterBatch, key: GlideString, path: GlideString, num: number): Batch | ClusterBatch;
     /**
      * Retrieves the number of key-value pairs in the object stored at the specified `path` within the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) Additional parameters:
      * - (Optional) `path`: The path within the JSON document, Defaults to root (`"."`) if not provided.
@@ -1306,13 +1306,13 @@ export declare class JsonBatch {
      *      - If the JSON value at `path` is not an object or if `path` doesn't exist, an error is raised.
      *    - If `key` doesn't exist, `null` is returned.
      */
-    static objlen(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static objlen(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
     /**
      * Retrieves key names in the object values at the specified `path` within the JSON document stored at `key`.
      *
-     * @param transaction - A transaction to add commands to.
+     * @param batch - A batch to add commands to.
      * @param key - The key of the JSON document.
      * @param options - (Optional) Additional parameters:
      * - (Optional) `path`: The path within the JSON document where the key names will be retrieved. Defaults to root (`"."`) if not provided.
@@ -1329,7 +1329,7 @@ export declare class JsonBatch {
      *      - If `path` doesn't exist, `null` is returned.
      *    - If `key` doesn't exist, `null` is returned.
      */
-    static objkeys(transaction: Transaction | ClusterTransaction, key: GlideString, options?: {
+    static objkeys(batch: Batch | ClusterBatch, key: GlideString, options?: {
         path: GlideString;
-    }): Transaction | ClusterTransaction;
+    }): Batch | ClusterBatch;
 }