@redis/json 5.1.1 → 5.5.6

package/dist/lib/commands/ARRAPPEND.d.ts

@@ -3,6 +3,16 @@ import { RedisJSON } from './helpers';
 import { RedisArgument, NumberReply, ArrayReply, NullReply } from '@redis/client/dist/lib/RESP/types';
 declare const _default: {
     readonly IS_READ_ONLY: false;
+    /**
+     * Appends one or more values to the end of an array in a JSON document.
+     * Returns the new array length after append, or null if the path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key to append to
+     * @param path - Path to the array in the JSON document
+     * @param json - The first value to append
+     * @param jsons - Additional values to append
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, path: RedisArgument, json: RedisJSON, ...jsons: Array<RedisJSON>) => void;
     readonly transformReply: () => NumberReply | ArrayReply<NumberReply | NullReply>;
 };

package/dist/lib/commands/ARRAPPEND.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ARRAPPEND.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRAPPEND.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,SAAS,EAA8B,MAAM,WAAW,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAW,MAAM,mCAAmC,CAAC;;;gDAKnG,aAAa,OAChB,aAAa,QACZ,aAAa,QACb,SAAS,YACL,MAAM,SAAS,CAAC;mCAUkB,WAAW,GAAG,WAAW,WAAW,GAAG,SAAS,CAAC;;AAjBjG,wBAkB6B"}
+{"version":3,"file":"ARRAPPEND.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRAPPEND.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,SAAS,EAA8B,MAAM,WAAW,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAW,MAAM,mCAAmC,CAAC;;;IAI7G;;;;;;;;;OASG;gDAEO,aAAa,OAChB,aAAa,QACZ,aAAa,QACb,SAAS,YACL,MAAM,SAAS,CAAC;mCAUkB,WAAW,GAAG,WAAW,WAAW,GAAG,SAAS,CAAC;;AA3BjG,wBA4B6B"}

package/dist/lib/commands/ARRAPPEND.js

@@ -3,6 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const helpers_1 = require("./helpers");
 exports.default = {
     IS_READ_ONLY: false,
+    /**
+     * Appends one or more values to the end of an array in a JSON document.
+     * Returns the new array length after append, or null if the path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key to append to
+     * @param path - Path to the array in the JSON document
+     * @param json - The first value to append
+     * @param jsons - Additional values to append
+     */
     parseCommand(parser, key, path, json, ...jsons) {
         parser.push('JSON.ARRAPPEND');
         parser.pushKey(key);

package/dist/lib/commands/ARRAPPEND.js.map

@@ -1 +1 @@
-{"version":3,"file":"ARRAPPEND.js","sourceRoot":"","sources":["../../../lib/commands/ARRAPPEND.ts"],"names":[],"mappings":";;AACA,uCAAkE;AAGlE,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB,YAAY,CACV,MAAqB,EACrB,GAAkB,EAClB,IAAmB,EACnB,IAAe,EACf,GAAG,KAAuB;QAE1B,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAA,oCAA0B,EAAC,IAAI,CAAC,CAAC,CAAC;QAEpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,IAAA,oCAA0B,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAA+E;CACrE,CAAC"}
+{"version":3,"file":"ARRAPPEND.js","sourceRoot":"","sources":["../../../lib/commands/ARRAPPEND.ts"],"names":[],"mappings":";;AACA,uCAAkE;AAGlE,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB;;;;;;;;;OASG;IACH,YAAY,CACV,MAAqB,EACrB,GAAkB,EAClB,IAAmB,EACnB,IAAe,EACf,GAAG,KAAuB;QAE1B,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAA,oCAA0B,EAAC,IAAI,CAAC,CAAC,CAAC;QAEpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,IAAA,oCAA0B,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAA+E;CACrE,CAAC"}

package/dist/lib/commands/ARRINDEX.d.ts

@@ -9,6 +9,18 @@ export interface JsonArrIndexOptions {
 }
 declare const _default: {
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns the index of the first occurrence of a value in a JSON array.
+     * If the specified value is not found, it returns -1, or null if the path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the array
+     * @param path - Path to the array in the JSON document
+     * @param json - The value to search for
+     * @param options - Optional range parameters for the search
+     * @param options.range.start - Starting index for the search
+     * @param options.range.stop - Optional ending index for the search
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, path: RedisArgument, json: RedisJSON, options?: JsonArrIndexOptions) => void;
     readonly transformReply: () => NumberReply | ArrayReply<NumberReply | NullReply>;
 };

package/dist/lib/commands/ARRINDEX.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ARRINDEX.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRINDEX.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAW,MAAM,mCAAmC,CAAC;AAC/G,OAAO,EAAE,SAAS,EAA8B,MAAM,WAAW,CAAC;AAElE,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;;;gDAKW,aAAa,OAChB,aAAa,QACZ,aAAa,QACb,SAAS,YACL,mBAAmB;mCAce,WAAW,GAAG,WAAW,WAAW,GAAG,SAAS,CAAC;;AArBjG,wBAsB6B"}
+{"version":3,"file":"ARRINDEX.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRINDEX.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAW,MAAM,mCAAmC,CAAC;AAC/G,OAAO,EAAE,SAAS,EAA8B,MAAM,WAAW,CAAC;AAElE,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;;;IAIC;;;;;;;;;;;OAWG;gDAEO,aAAa,OAChB,aAAa,QACZ,aAAa,QACb,SAAS,YACL,mBAAmB;mCAce,WAAW,GAAG,WAAW,WAAW,GAAG,SAAS,CAAC;;AAjCjG,wBAkC6B"}

package/dist/lib/commands/ARRINDEX.js

@@ -3,6 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const helpers_1 = require("./helpers");
 exports.default = {
     IS_READ_ONLY: true,
+    /**
+     * Returns the index of the first occurrence of a value in a JSON array.
+     * If the specified value is not found, it returns -1, or null if the path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the array
+     * @param path - Path to the array in the JSON document
+     * @param json - The value to search for
+     * @param options - Optional range parameters for the search
+     * @param options.range.start - Starting index for the search
+     * @param options.range.stop - Optional ending index for the search
+     */
     parseCommand(parser, key, path, json, options) {
         parser.push('JSON.ARRINDEX');
         parser.pushKey(key);

package/dist/lib/commands/ARRINDEX.js.map

@@ -1 +1 @@
-{"version":3,"file":"ARRINDEX.js","sourceRoot":"","sources":["../../../lib/commands/ARRINDEX.ts"],"names":[],"mappings":";;AAEA,uCAAkE;AASlE,kBAAe;IACb,YAAY,EAAE,IAAI;IAClB,YAAY,CACV,MAAqB,EACrB,GAAkB,EAClB,IAAmB,EACnB,IAAe,EACf,OAA6B;QAE7B,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAA,oCAA0B,EAAC,IAAI,CAAC,CAAC,CAAC;QAEpD,IAAI,OAAO,EAAE,KAAK,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE5C,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAA+E;CACrE,CAAC"}
+{"version":3,"file":"ARRINDEX.js","sourceRoot":"","sources":["../../../lib/commands/ARRINDEX.ts"],"names":[],"mappings":";;AAEA,uCAAkE;AASlE,kBAAe;IACb,YAAY,EAAE,IAAI;IAClB;;;;;;;;;;;OAWG;IACH,YAAY,CACV,MAAqB,EACrB,GAAkB,EAClB,IAAmB,EACnB,IAAe,EACf,OAA6B;QAE7B,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAA,oCAA0B,EAAC,IAAI,CAAC,CAAC,CAAC;QAEpD,IAAI,OAAO,EAAE,KAAK,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE5C,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAA+E;CACrE,CAAC"}

package/dist/lib/commands/ARRINSERT.d.ts

@@ -3,6 +3,17 @@ import { RedisArgument, NumberReply, ArrayReply, NullReply } from '@redis/client
 import { RedisJSON } from './helpers';
 declare const _default: {
     readonly IS_READ_ONLY: false;
+    /**
+     * Inserts one or more values into an array at the specified index.
+     * Returns the new array length after insert, or null if the path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the array
+     * @param path - Path to the array in the JSON document
+     * @param index - The position where to insert the values
+     * @param json - The first value to insert
+     * @param jsons - Additional values to insert
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, path: RedisArgument, index: number, json: RedisJSON, ...jsons: Array<RedisJSON>) => void;
     readonly transformReply: () => NumberReply | ArrayReply<NumberReply | NullReply>;
 };

package/dist/lib/commands/ARRINSERT.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ARRINSERT.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRINSERT.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAW,MAAM,mCAAmC,CAAC;AAC/G,OAAO,EAAE,SAAS,EAA8B,MAAM,WAAW,CAAC;;;gDAKtD,aAAa,OAChB,aAAa,QACZ,aAAa,SACZ,MAAM,QACP,SAAS,YACL,MAAM,SAAS,CAAC;mCAUkB,WAAW,GAAG,WAAW,WAAW,GAAG,SAAS,CAAC;;AAlBjG,wBAmB6B"}
+{"version":3,"file":"ARRINSERT.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRINSERT.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAW,MAAM,mCAAmC,CAAC;AAC/G,OAAO,EAAE,SAAS,EAA8B,MAAM,WAAW,CAAC;;;IAIhE;;;;;;;;;;OAUG;gDAEO,aAAa,OAChB,aAAa,QACZ,aAAa,SACZ,MAAM,QACP,SAAS,YACL,MAAM,SAAS,CAAC;mCAUkB,WAAW,GAAG,WAAW,WAAW,GAAG,SAAS,CAAC;;AA7BjG,wBA8B6B"}

package/dist/lib/commands/ARRINSERT.js

@@ -3,6 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const helpers_1 = require("./helpers");
 exports.default = {
     IS_READ_ONLY: false,
+    /**
+     * Inserts one or more values into an array at the specified index.
+     * Returns the new array length after insert, or null if the path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the array
+     * @param path - Path to the array in the JSON document
+     * @param index - The position where to insert the values
+     * @param json - The first value to insert
+     * @param jsons - Additional values to insert
+     */
     parseCommand(parser, key, path, index, json, ...jsons) {
         parser.push('JSON.ARRINSERT');
         parser.pushKey(key);

package/dist/lib/commands/ARRINSERT.js.map

@@ -1 +1 @@
-{"version":3,"file":"ARRINSERT.js","sourceRoot":"","sources":["../../../lib/commands/ARRINSERT.ts"],"names":[],"mappings":";;AAEA,uCAAkE;AAElE,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB,YAAY,CACV,MAAqB,EACrB,GAAkB,EAClB,IAAmB,EACnB,KAAa,EACb,IAAe,EACf,GAAG,KAAuB;QAE1B,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,IAAA,oCAA0B,EAAC,IAAI,CAAC,CAAC,CAAC;QAEtE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,IAAA,oCAA0B,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAA+E;CACrE,CAAC"}
+{"version":3,"file":"ARRINSERT.js","sourceRoot":"","sources":["../../../lib/commands/ARRINSERT.ts"],"names":[],"mappings":";;AAEA,uCAAkE;AAElE,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB;;;;;;;;;;OAUG;IACH,YAAY,CACV,MAAqB,EACrB,GAAkB,EAClB,IAAmB,EACnB,KAAa,EACb,IAAe,EACf,GAAG,KAAuB;QAE1B,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,IAAA,oCAA0B,EAAC,IAAI,CAAC,CAAC,CAAC;QAEtE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,IAAA,oCAA0B,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAA+E;CACrE,CAAC"}

package/dist/lib/commands/ARRLEN.d.ts

@@ -5,6 +5,15 @@ export interface JsonArrLenOptions {
 }
 declare const _default: {
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns the length of an array in a JSON document.
+     * Returns null if the path does not exist or the value is not an array.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the array
+     * @param options - Optional parameters
+     * @param options.path - Path to the array in the JSON document
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, options?: JsonArrLenOptions) => void;
     readonly transformReply: () => NumberReply | ArrayReply<NumberReply | NullReply>;
 };

package/dist/lib/commands/ARRLEN.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ARRLEN.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRLEN.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAW,MAAM,mCAAmC,CAAC;AAE/G,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;;;gDAIsB,aAAa,OAAO,aAAa,YAAY,iBAAiB;mCAOrC,WAAW,GAAG,WAAW,WAAW,GAAG,SAAS,CAAC;;AATjG,wBAU6B"}
+{"version":3,"file":"ARRLEN.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRLEN.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAW,MAAM,mCAAmC,CAAC;AAE/G,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;;;IAIC;;;;;;;;OAQG;gDACkB,aAAa,OAAO,aAAa,YAAY,iBAAiB;mCAOrC,WAAW,GAAG,WAAW,WAAW,GAAG,SAAS,CAAC;;AAlBjG,wBAmB6B"}

package/dist/lib/commands/ARRLEN.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     IS_READ_ONLY: true,
+    /**
+     * Returns the length of an array in a JSON document.
+     * Returns null if the path does not exist or the value is not an array.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the array
+     * @param options - Optional parameters
+     * @param options.path - Path to the array in the JSON document
+     */
     parseCommand(parser, key, options) {
         parser.push('JSON.ARRLEN');
         parser.pushKey(key);

package/dist/lib/commands/ARRLEN.js.map

@@ -1 +1 @@
-{"version":3,"file":"ARRLEN.js","sourceRoot":"","sources":["../../../lib/commands/ARRLEN.ts"],"names":[],"mappings":";;AAOA,kBAAe;IACb,YAAY,EAAE,IAAI;IAClB,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAA2B;QACjF,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAA+E;CACrE,CAAC"}
+{"version":3,"file":"ARRLEN.js","sourceRoot":"","sources":["../../../lib/commands/ARRLEN.ts"],"names":[],"mappings":";;AAOA,kBAAe;IACb,YAAY,EAAE,IAAI;IAClB;;;;;;;;OAQG;IACH,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAA2B;QACjF,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAA+E;CACrE,CAAC"}

package/dist/lib/commands/ARRPOP.d.ts

@@ -6,6 +6,16 @@ export interface RedisArrPopOptions {
 }
 declare const _default: {
     readonly IS_READ_ONLY: false;
+    /**
+     * Removes and returns an element from an array in a JSON document.
+     * Returns null if the path does not exist or the value is not an array.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the array
+     * @param options - Optional parameters
+     * @param options.path - Path to the array in the JSON document
+     * @param options.index - Optional index to pop from. Default is -1 (last element)
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, options?: RedisArrPopOptions) => void;
     readonly transformReply: (this: void, reply: NullReply | BlobStringReply | ArrayReply<NullReply | BlobStringReply>) => string | number | boolean | NullReply | Date | {
         [key: string]: import("./helpers").RedisJSON;

package/dist/lib/commands/ARRPOP.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ARRPOP.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRPOP.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAwB,MAAM,mCAAmC,CAAC;AAIhI,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;;;gDAIsB,aAAa,OAAO,aAAa,YAAY,kBAAkB;iDAY9D,SAAS,GAAG,eAAe,GAAG,WAAW,SAAS,GAAG,eAAe,CAAC;;;;;AAd7F,wBAmB6B"}
+{"version":3,"file":"ARRPOP.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRPOP.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAwB,MAAM,mCAAmC,CAAC;AAIhI,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;;;IAIC;;;;;;;;;OASG;gDACkB,aAAa,OAAO,aAAa,YAAY,kBAAkB;iDAY9D,SAAS,GAAG,eAAe,GAAG,WAAW,SAAS,GAAG,eAAe,CAAC;;;;;AAxB7F,wBA6B6B"}

package/dist/lib/commands/ARRPOP.js

@@ -4,6 +4,16 @@ const generic_transformers_1 = require("@redis/client/dist/lib/commands/generic-
 const helpers_1 = require("./helpers");
 exports.default = {
     IS_READ_ONLY: false,
+    /**
+     * Removes and returns an element from an array in a JSON document.
+     * Returns null if the path does not exist or the value is not an array.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the array
+     * @param options - Optional parameters
+     * @param options.path - Path to the array in the JSON document
+     * @param options.index - Optional index to pop from. Default is -1 (last element)
+     */
     parseCommand(parser, key, options) {
         parser.push('JSON.ARRPOP');
         parser.pushKey(key);

package/dist/lib/commands/ARRPOP.js.map

@@ -1 +1 @@
-{"version":3,"file":"ARRPOP.js","sourceRoot":"","sources":["../../../lib/commands/ARRPOP.ts"],"names":[],"mappings":";;AAEA,+FAAoF;AACpF,uCAAwD;AAOxD,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAA4B;QAClF,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEpB,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAE1B,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;IACH,CAAC;IACD,cAAc,CAAC,KAA4E;QACzF,OAAO,IAAA,mCAAY,EAAC,KAAK,CAAC,CAAC,CAAC;YACzB,KAA8C,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,qCAA2B,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAChG,IAAA,qCAA2B,EAAC,KAAK,CAAC,CAAC;IACvC,CAAC;CACyB,CAAC"}
+{"version":3,"file":"ARRPOP.js","sourceRoot":"","sources":["../../../lib/commands/ARRPOP.ts"],"names":[],"mappings":";;AAEA,+FAAoF;AACpF,uCAAwD;AAOxD,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB;;;;;;;;;OASG;IACH,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAA4B;QAClF,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEpB,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAE1B,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;IACH,CAAC;IACD,cAAc,CAAC,KAA4E;QACzF,OAAO,IAAA,mCAAY,EAAC,KAAK,CAAC,CAAC,CAAC;YACzB,KAA8C,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,qCAA2B,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAChG,IAAA,qCAA2B,EAAC,KAAK,CAAC,CAAC;IACvC,CAAC;CACyB,CAAC"}

package/dist/lib/commands/ARRTRIM.d.ts

@@ -2,6 +2,16 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
 import { RedisArgument, ArrayReply, NumberReply, NullReply } from '@redis/client/dist/lib/RESP/types';
 declare const _default: {
     readonly IS_READ_ONLY: false;
+    /**
+     * Trims an array in a JSON document to include only elements within the specified range.
+     * Returns the new array length after trimming, or null if the path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the array
+     * @param path - Path to the array in the JSON document
+     * @param start - Starting index (inclusive)
+     * @param stop - Ending index (inclusive)
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, path: RedisArgument, start: number, stop: number) => void;
     readonly transformReply: () => NumberReply | ArrayReply<NumberReply | NullReply>;
 };

package/dist/lib/commands/ARRTRIM.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ARRTRIM.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRTRIM.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAW,MAAM,mCAAmC,CAAC;;;gDAIxF,aAAa,OAAO,aAAa,QAAQ,aAAa,SAAS,MAAM,QAAQ,MAAM;mCAK1D,WAAW,GAAG,WAAW,WAAW,GAAG,SAAS,CAAC;;AAPjG,wBAQ6B"}
+{"version":3,"file":"ARRTRIM.d.ts","sourceRoot":"","sources":["../../../lib/commands/ARRTRIM.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAW,MAAM,mCAAmC,CAAC;;;IAI7G;;;;;;;;;OASG;gDACkB,aAAa,OAAO,aAAa,QAAQ,aAAa,SAAS,MAAM,QAAQ,MAAM;mCAK1D,WAAW,GAAG,WAAW,WAAW,GAAG,SAAS,CAAC;;AAjBjG,wBAkB6B"}

package/dist/lib/commands/ARRTRIM.js

@@ -2,6 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     IS_READ_ONLY: false,
+    /**
+     * Trims an array in a JSON document to include only elements within the specified range.
+     * Returns the new array length after trimming, or null if the path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the array
+     * @param path - Path to the array in the JSON document
+     * @param start - Starting index (inclusive)
+     * @param stop - Ending index (inclusive)
+     */
     parseCommand(parser, key, path, start, stop) {
         parser.push('JSON.ARRTRIM');
         parser.pushKey(key);

package/dist/lib/commands/ARRTRIM.js.map

@@ -1 +1 @@
-{"version":3,"file":"ARRTRIM.js","sourceRoot":"","sources":["../../../lib/commands/ARRTRIM.ts"],"names":[],"mappings":";;AAGA,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,IAAmB,EAAE,KAAa,EAAE,IAAY;QACtG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACvD,CAAC;IACD,cAAc,EAAE,SAA+E;CACrE,CAAC"}
+{"version":3,"file":"ARRTRIM.js","sourceRoot":"","sources":["../../../lib/commands/ARRTRIM.ts"],"names":[],"mappings":";;AAGA,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB;;;;;;;;;OASG;IACH,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,IAAmB,EAAE,KAAa,EAAE,IAAY;QACtG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACvD,CAAC;IACD,cAAc,EAAE,SAA+E;CACrE,CAAC"}

package/dist/lib/commands/CLEAR.d.ts

@@ -5,6 +5,15 @@ export interface JsonClearOptions {
 }
 declare const _default: {
     readonly IS_READ_ONLY: false;
+    /**
+     * Clears container values (arrays/objects) in a JSON document.
+     * Returns the number of values cleared (0 or 1), or null if the path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param options - Optional parameters
+     * @param options.path - Path to the container to clear
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, options?: JsonClearOptions) => void;
     readonly transformReply: () => NumberReply;
 };

package/dist/lib/commands/CLEAR.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CLEAR.d.ts","sourceRoot":"","sources":["../../../lib/commands/CLEAR.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAW,MAAM,mCAAmC,CAAC;AAExF,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;;;gDAIsB,aAAa,OAAO,aAAa,YAAY,gBAAgB;mCAQpC,WAAW;;AAV3D,wBAW6B"}
+{"version":3,"file":"CLEAR.d.ts","sourceRoot":"","sources":["../../../lib/commands/CLEAR.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAW,MAAM,mCAAmC,CAAC;AAExF,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;;;IAIC;;;;;;;;OAQG;gDACkB,aAAa,OAAO,aAAa,YAAY,gBAAgB;mCAQpC,WAAW;;AAnB3D,wBAoB6B"}

package/dist/lib/commands/CLEAR.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     IS_READ_ONLY: false,
+    /**
+     * Clears container values (arrays/objects) in a JSON document.
+     * Returns the number of values cleared (0 or 1), or null if the path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param options - Optional parameters
+     * @param options.path - Path to the container to clear
+     */
     parseCommand(parser, key, options) {
         parser.push('JSON.CLEAR');
         parser.pushKey(key);

package/dist/lib/commands/CLEAR.js.map

@@ -1 +1 @@
-{"version":3,"file":"CLEAR.js","sourceRoot":"","sources":["../../../lib/commands/CLEAR.ts"],"names":[],"mappings":";;AAOA,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAA0B;QAChF,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAAyC;CAC/B,CAAC"}
+{"version":3,"file":"CLEAR.js","sourceRoot":"","sources":["../../../lib/commands/CLEAR.ts"],"names":[],"mappings":";;AAOA,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB;;;;;;;;OAQG;IACH,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAA0B;QAChF,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAAyC;CAC/B,CAAC"}

package/dist/lib/commands/DEBUG_MEMORY.d.ts

@@ -5,6 +5,15 @@ export interface JsonDebugMemoryOptions {
 }
 declare const _default: {
     readonly IS_READ_ONLY: false;
+    /**
+     * Reports memory usage details for a JSON document value.
+     * Returns size in bytes of the value, or null if the key or path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param options - Optional parameters
+     * @param options.path - Path to the value to examine
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, options?: JsonDebugMemoryOptions) => void;
     readonly transformReply: () => NumberReply;
 };

package/dist/lib/commands/DEBUG_MEMORY.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DEBUG_MEMORY.d.ts","sourceRoot":"","sources":["../../../lib/commands/DEBUG_MEMORY.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAW,MAAM,mCAAmC,CAAC;AAExF,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;;;gDAIsB,aAAa,OAAO,aAAa,YAAY,sBAAsB;mCAQ1C,WAAW;;AAV3D,wBAW6B"}
+{"version":3,"file":"DEBUG_MEMORY.d.ts","sourceRoot":"","sources":["../../../lib/commands/DEBUG_MEMORY.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAW,MAAM,mCAAmC,CAAC;AAExF,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;;;IAIC;;;;;;;;OAQG;gDACkB,aAAa,OAAO,aAAa,YAAY,sBAAsB;mCAQ1C,WAAW;;AAnB3D,wBAoB6B"}

package/dist/lib/commands/DEBUG_MEMORY.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     IS_READ_ONLY: false,
+    /**
+     * Reports memory usage details for a JSON document value.
+     * Returns size in bytes of the value, or null if the key or path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param options - Optional parameters
+     * @param options.path - Path to the value to examine
+     */
     parseCommand(parser, key, options) {
         parser.push('JSON.DEBUG', 'MEMORY');
         parser.pushKey(key);

package/dist/lib/commands/DEBUG_MEMORY.js.map

@@ -1 +1 @@
-{"version":3,"file":"DEBUG_MEMORY.js","sourceRoot":"","sources":["../../../lib/commands/DEBUG_MEMORY.ts"],"names":[],"mappings":";;AAOA,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAAgC;QACtF,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAAyC;CAC/B,CAAC"}
+{"version":3,"file":"DEBUG_MEMORY.js","sourceRoot":"","sources":["../../../lib/commands/DEBUG_MEMORY.ts"],"names":[],"mappings":";;AAOA,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB;;;;;;;;OAQG;IACH,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAAgC;QACtF,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAAyC;CAC/B,CAAC"}

package/dist/lib/commands/DEL.d.ts

@@ -5,6 +5,15 @@ export interface JsonDelOptions {
 }
 declare const _default: {
     readonly IS_READ_ONLY: false;
+    /**
+     * Deletes a value from a JSON document.
+     * Returns the number of paths deleted (0 or 1), or null if the key does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param options - Optional parameters
+     * @param options.path - Path to the value to delete
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, options?: JsonDelOptions) => void;
     readonly transformReply: () => NumberReply;
 };

package/dist/lib/commands/DEL.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DEL.d.ts","sourceRoot":"","sources":["../../../lib/commands/DEL.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAW,MAAM,mCAAmC,CAAC;AAExF,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,aAAa,CAAA;CACrB;;;gDAIsB,aAAa,OAAO,aAAa,YAAY,cAAc;mCAQlC,WAAW;;AAV3D,wBAW6B"}
+{"version":3,"file":"DEL.d.ts","sourceRoot":"","sources":["../../../lib/commands/DEL.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAW,MAAM,mCAAmC,CAAC;AAExF,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,aAAa,CAAA;CACrB;;;IAIC;;;;;;;;OAQG;gDACkB,aAAa,OAAO,aAAa,YAAY,cAAc;mCAQlC,WAAW;;AAnB3D,wBAoB6B"}

package/dist/lib/commands/DEL.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     IS_READ_ONLY: false,
+    /**
+     * Deletes a value from a JSON document.
+     * Returns the number of paths deleted (0 or 1), or null if the key does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param options - Optional parameters
+     * @param options.path - Path to the value to delete
+     */
     parseCommand(parser, key, options) {
         parser.push('JSON.DEL');
         parser.pushKey(key);

package/dist/lib/commands/DEL.js.map

@@ -1 +1 @@
-{"version":3,"file":"DEL.js","sourceRoot":"","sources":["../../../lib/commands/DEL.ts"],"names":[],"mappings":";;AAOA,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAAwB;QAC9E,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAAyC;CAC/B,CAAC"}
+{"version":3,"file":"DEL.js","sourceRoot":"","sources":["../../../lib/commands/DEL.ts"],"names":[],"mappings":";;AAOA,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB;;;;;;;;OAQG;IACH,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAAwB;QAC9E,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAAyC;CAC/B,CAAC"}

package/dist/lib/commands/FORGET.d.ts

@@ -5,6 +5,15 @@ export interface JsonForgetOptions {
 }
 declare const _default: {
     readonly IS_READ_ONLY: false;
+    /**
+     * Alias for JSON.DEL - Deletes a value from a JSON document.
+     * Returns the number of paths deleted (0 or 1), or null if the key does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param options - Optional parameters
+     * @param options.path - Path to the value to delete
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, options?: JsonForgetOptions) => void;
     readonly transformReply: () => NumberReply;
 };

package/dist/lib/commands/FORGET.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FORGET.d.ts","sourceRoot":"","sources":["../../../lib/commands/FORGET.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAW,MAAM,mCAAmC,CAAC;AAExF,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;;;gDAIsB,aAAa,OAAO,aAAa,YAAY,iBAAiB;mCAQrC,WAAW;;AAV3D,wBAW6B"}
+{"version":3,"file":"FORGET.d.ts","sourceRoot":"","sources":["../../../lib/commands/FORGET.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAW,MAAM,mCAAmC,CAAC;AAExF,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;;;IAIC;;;;;;;;OAQG;gDACkB,aAAa,OAAO,aAAa,YAAY,iBAAiB;mCAQrC,WAAW;;AAnB3D,wBAoB6B"}

package/dist/lib/commands/FORGET.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     IS_READ_ONLY: false,
+    /**
+     * Alias for JSON.DEL - Deletes a value from a JSON document.
+     * Returns the number of paths deleted (0 or 1), or null if the key does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param options - Optional parameters
+     * @param options.path - Path to the value to delete
+     */
     parseCommand(parser, key, options) {
         parser.push('JSON.FORGET');
         parser.pushKey(key);

package/dist/lib/commands/FORGET.js.map

@@ -1 +1 @@
-{"version":3,"file":"FORGET.js","sourceRoot":"","sources":["../../../lib/commands/FORGET.ts"],"names":[],"mappings":";;AAOA,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAA2B;QACjF,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAAyC;CAC/B,CAAC"}
+{"version":3,"file":"FORGET.js","sourceRoot":"","sources":["../../../lib/commands/FORGET.ts"],"names":[],"mappings":";;AAOA,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB;;;;;;;;OAQG;IACH,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,OAA2B;QACjF,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,cAAc,EAAE,SAAyC;CAC/B,CAAC"}

package/dist/lib/commands/GET.d.ts

@@ -7,6 +7,15 @@ export interface JsonGetOptions {
 }
 declare const _default: {
     readonly IS_READ_ONLY: false;
+    /**
+     * Gets values from a JSON document.
+     * Returns the value at the specified path, or null if the key or path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param options - Optional parameters
+     * @param options.path - Path(s) to the value(s) to retrieve
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, options?: JsonGetOptions) => void;
     readonly transformReply: typeof transformRedisJsonNullReply;
 };

package/dist/lib/commands/GET.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GET.d.ts","sourceRoot":"","sources":["../../../lib/commands/GET.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAW,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,sDAAsD,CAAC;AAC7F,OAAO,EAAE,2BAA2B,EAAE,MAAM,WAAW,CAAC;AAExD,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,qBAAqB,CAAC;CAC9B;;;gDAKW,aAAa,OAChB,aAAa,YACR,cAAc;;;AAL5B,wBAc6B"}
+{"version":3,"file":"GET.d.ts","sourceRoot":"","sources":["../../../lib/commands/GET.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAW,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,sDAAsD,CAAC;AAC7F,OAAO,EAAE,2BAA2B,EAAE,MAAM,WAAW,CAAC;AAExD,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,qBAAqB,CAAC;CAC9B;;;IAIC;;;;;;;;OAQG;gDAEO,aAAa,OAChB,aAAa,YACR,cAAc;;;AAd5B,wBAuB6B"}

package/dist/lib/commands/GET.js

@@ -3,6 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const helpers_1 = require("./helpers");
 exports.default = {
     IS_READ_ONLY: false,
+    /**
+     * Gets values from a JSON document.
+     * Returns the value at the specified path, or null if the key or path does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param options - Optional parameters
+     * @param options.path - Path(s) to the value(s) to retrieve
+     */
     parseCommand(parser, key, options) {
         parser.push('JSON.GET');
         parser.pushKey(key);

package/dist/lib/commands/GET.js.map

@@ -1 +1 @@
-{"version":3,"file":"GET.js","sourceRoot":"","sources":["../../../lib/commands/GET.ts"],"names":[],"mappings":";;AAGA,uCAAwD;AAMxD,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB,YAAY,CACV,MAAqB,EACrB,GAAkB,EAClB,OAAwB;QAExB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IACD,cAAc,EAAE,qCAA2B;CACjB,CAAC"}
+{"version":3,"file":"GET.js","sourceRoot":"","sources":["../../../lib/commands/GET.ts"],"names":[],"mappings":";;AAGA,uCAAwD;AAMxD,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB;;;;;;;;OAQG;IACH,YAAY,CACV,MAAqB,EACrB,GAAkB,EAClB,OAAwB;QAExB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IACD,cAAc,EAAE,qCAA2B;CACjB,CAAC"}

package/dist/lib/commands/MERGE.d.ts

@@ -3,6 +3,15 @@ import { SimpleStringReply, RedisArgument } from '@redis/client/dist/lib/RESP/ty
 import { RedisJSON } from './helpers';
 declare const _default: {
     readonly IS_READ_ONLY: false;
+    /**
+     * Merges a given JSON value into a JSON document.
+     * Returns OK on success, or null if the key does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param path - Path to merge into
+     * @param value - JSON value to merge
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, path: RedisArgument, value: RedisJSON) => void;
     readonly transformReply: () => SimpleStringReply<'OK'>;
 };

package/dist/lib/commands/MERGE.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MERGE.d.ts","sourceRoot":"","sources":["../../../lib/commands/MERGE.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAW,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAC9F,OAAO,EAAE,SAAS,EAA8B,MAAM,WAAW,CAAC;;;gDAI3C,aAAa,OAAO,aAAa,QAAQ,aAAa,SAAS,SAAS;mCAK/C,kBAAkB,IAAI,CAAC;;AAPvE,wBAQ6B"}
+{"version":3,"file":"MERGE.d.ts","sourceRoot":"","sources":["../../../lib/commands/MERGE.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAW,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAC9F,OAAO,EAAE,SAAS,EAA8B,MAAM,WAAW,CAAC;;;IAIhE;;;;;;;;OAQG;gDACkB,aAAa,OAAO,aAAa,QAAQ,aAAa,SAAS,SAAS;mCAK/C,kBAAkB,IAAI,CAAC;;AAhBvE,wBAiB6B"}

package/dist/lib/commands/MERGE.js

@@ -3,6 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const helpers_1 = require("./helpers");
 exports.default = {
     IS_READ_ONLY: false,
+    /**
+     * Merges a given JSON value into a JSON document.
+     * Returns OK on success, or null if the key does not exist.
+     *
+     * @param parser - The Redis command parser
+     * @param key - The key containing the JSON document
+     * @param path - Path to merge into
+     * @param value - JSON value to merge
+     */
     parseCommand(parser, key, path, value) {
         parser.push('JSON.MERGE');
         parser.pushKey(key);

package/dist/lib/commands/MERGE.js.map

@@ -1 +1 @@
-{"version":3,"file":"MERGE.js","sourceRoot":"","sources":["../../../lib/commands/MERGE.ts"],"names":[],"mappings":";;AAEA,uCAAkE;AAElE,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,IAAmB,EAAE,KAAgB;QAC3F,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAA,oCAA0B,EAAC,KAAK,CAAC,CAAC,CAAC;IACvD,CAAC;IACD,cAAc,EAAE,SAAqD;CAC3C,CAAC"}
+{"version":3,"file":"MERGE.js","sourceRoot":"","sources":["../../../lib/commands/MERGE.ts"],"names":[],"mappings":";;AAEA,uCAAkE;AAElE,kBAAe;IACb,YAAY,EAAE,KAAK;IACnB;;;;;;;;OAQG;IACH,YAAY,CAAC,MAAqB,EAAE,GAAkB,EAAE,IAAmB,EAAE,KAAgB;QAC3F,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAA,oCAA0B,EAAC,KAAK,CAAC,CAAC,CAAC;IACvD,CAAC;IACD,cAAc,EAAE,SAAqD;CAC3C,CAAC"}

package/dist/lib/commands/MGET.d.ts

@@ -2,6 +2,14 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
 import { RedisArgument, UnwrapReply, ArrayReply, NullReply, BlobStringReply } from '@redis/client/dist/lib/RESP/types';
 declare const _default: {
     readonly IS_READ_ONLY: true;
+    /**
+     * Gets values at a specific path from multiple JSON documents.
+     * Returns an array of values at the path from each key, null for missing keys/paths.
+     *
+     * @param parser - The Redis command parser
+     * @param keys - Array of keys containing JSON documents
+     * @param path - Path to retrieve from each document
+     */
     readonly parseCommand: (this: void, parser: CommandParser, keys: Array<RedisArgument>, path: RedisArgument) => void;
     readonly transformReply: (this: void, reply: UnwrapReply<ArrayReply<NullReply | BlobStringReply>>) => (NullReply | import("./helpers").RedisJSON)[];
 };

package/dist/lib/commands/MGET.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MGET.d.ts","sourceRoot":"","sources":["../../../lib/commands/MGET.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAW,MAAM,mCAAmC,CAAC;;;gDAKzG,aAAa,QAAQ,MAAM,aAAa,CAAC,QAAQ,aAAa;iDAK7D,YAAY,WAAW,SAAS,GAAG,eAAe,CAAC,CAAC;;AAP5E,wBAU6B"}
+{"version":3,"file":"MGET.d.ts","sourceRoot":"","sources":["../../../lib/commands/MGET.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAW,MAAM,mCAAmC,CAAC;;;IAK9H;;;;;;;OAOG;gDACkB,aAAa,QAAQ,MAAM,aAAa,CAAC,QAAQ,aAAa;iDAK7D,YAAY,WAAW,SAAS,GAAG,eAAe,CAAC,CAAC;;AAf5E,wBAkB6B"}

package/dist/lib/commands/MGET.js

@@ -3,6 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const helpers_1 = require("./helpers");
 exports.default = {
     IS_READ_ONLY: true,
+    /**
+     * Gets values at a specific path from multiple JSON documents.
+     * Returns an array of values at the path from each key, null for missing keys/paths.
+     *
+     * @param parser - The Redis command parser
+     * @param keys - Array of keys containing JSON documents
+     * @param path - Path to retrieve from each document
+     */
     parseCommand(parser, keys, path) {
         parser.push('JSON.MGET');
         parser.pushKeys(keys);

package/dist/lib/commands/MGET.js.map

@@ -1 +1 @@
-{"version":3,"file":"MGET.js","sourceRoot":"","sources":["../../../lib/commands/MGET.ts"],"names":[],"mappings":";;AAEA,uCAAwD;AAExD,kBAAe;IACb,YAAY,EAAE,IAAI;IAClB,YAAY,CAAC,MAAqB,EAAE,IAA0B,EAAE,IAAmB;QACjF,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IACD,cAAc,CAAC,KAA2D;QACxE,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,qCAA2B,EAAC,IAAI,CAAC,CAAC,CAAA;IAC7D,CAAC;CACyB,CAAC"}
+{"version":3,"file":"MGET.js","sourceRoot":"","sources":["../../../lib/commands/MGET.ts"],"names":[],"mappings":";;AAEA,uCAAwD;AAExD,kBAAe;IACb,YAAY,EAAE,IAAI;IAClB;;;;;;;OAOG;IACH,YAAY,CAAC,MAAqB,EAAE,IAA0B,EAAE,IAAmB;QACjF,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IACD,cAAc,CAAC,KAA2D;QACxE,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,qCAA2B,EAAC,IAAI,CAAC,CAAC,CAAA;IAC7D,CAAC;CACyB,CAAC"}