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

23 lines
881 B
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
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);
parser.push(path, by.toString());
},
transformReply: NUMINCRBY.transformReply
} as const satisfies Command;