1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
Bobby I. 20c16e0c2c (docs) add jsdoc comments to command parsers (#2984)
* (docs) bloom: add jsdocs for all commands

* (docs) json: add jsdocs

* (docs) search: add jsdocs for all commands

* (docs) jsdocs for std commands

* (docs) jsdoc comments to time series commands
2025-06-03 14:38:07 +03:00

24 lines
918 B
TypeScript

import { CommandParser } from "@redis/client/dist/lib/client/parser";
import { Command, RedisArgument } from "@redis/client/dist/lib/RESP/types";
type RESPReply = Array<string | number | RESPReply>;
export default {
IS_READ_ONLY: true,
/**
* Returns the JSON value at the specified path in RESP (Redis Serialization Protocol) format.
* Returns the value in RESP form, useful for language-independent processing.
*
* @param parser - The Redis command parser
* @param key - The key containing the JSON document
* @param path - Optional path to the value in the document
*/
parseCommand(parser: CommandParser, key: RedisArgument, path?: string) {
parser.push('JSON.RESP');
parser.pushKey(key);
if (path !== undefined) {
parser.push(path);
}
},
transformReply: undefined as unknown as () => RESPReply
} as const satisfies Command;