1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-04 15:02:09 +03:00

(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
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

View File

@@ -4,6 +4,15 @@ import { RedisJSON, transformRedisJsonArgument } from './helpers';
export 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: CommandParser, key: RedisArgument, path: RedisArgument, value: RedisJSON) {
parser.push('JSON.MERGE');
parser.pushKey(key);