1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-10 11:43:01 +03:00
Files
node-redis/packages/json/lib/commands/GET.ts
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

33 lines
1.1 KiB
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
import { RedisVariadicArgument } from '@redis/client/dist/lib/commands/generic-transformers';
import { transformRedisJsonNullReply } from './helpers';
export interface JsonGetOptions {
path?: RedisVariadicArgument;
}
export 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: CommandParser,
key: RedisArgument,
options?: JsonGetOptions
) {
parser.push('JSON.GET');
parser.pushKey(key);
if (options?.path !== undefined) {
parser.pushVariadic(options.path);
}
},
transformReply: transformRedisJsonNullReply
} as const satisfies Command;