1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +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 NUMINCRBY from './NUMINCRBY';
export default {
IS_READ_ONLY: false,
/**
* Multiplies a numeric value stored in a JSON document by a given number.
* Returns the value after multiplication, or null if the key/path doesn't exist or value is not numeric.
*
* @param parser - The Redis command parser
* @param key - The key containing the JSON document
* @param path - Path to the numeric value
* @param by - Amount to multiply by
*/
parseCommand(parser: CommandParser, key: RedisArgument, path: RedisArgument, by: number) {
parser.push('JSON.NUMMULTBY');
parser.pushKey(key);