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/ARRTRIM.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
1020 B
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, ArrayReply, NumberReply, NullReply, Command } from '@redis/client/dist/lib/RESP/types';
export default {
IS_READ_ONLY: false,
/**
* Trims an array in a JSON document to include only elements within the specified range.
* Returns the new array length after trimming, or null if the path does not exist.
*
* @param parser - The Redis command parser
* @param key - The key containing the array
* @param path - Path to the array in the JSON document
* @param start - Starting index (inclusive)
* @param stop - Ending index (inclusive)
*/
parseCommand(parser: CommandParser, key: RedisArgument, path: RedisArgument, start: number, stop: number) {
parser.push('JSON.ARRTRIM');
parser.pushKey(key);
parser.push(path, start.toString(), stop.toString());
},
transformReply: undefined as unknown as () => NumberReply | ArrayReply<NumberReply | NullReply>
} as const satisfies Command;