redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +03:00
Code Activity

(docs) add jsdoc comments to command parsers (#2984)

Browse Source 
* (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
This commit is contained in:
Bobby I.
2025-06-03 14:38:07 +03:00
committed by GitHub
parent e4a1ca467f
commit 20c16e0c2c
491 changed files with 3861 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/json/lib/commands/RESP.ts
View File

@@ -5,6 +5,14 @@ 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);