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

61 lines
1.7 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, NumberReply, Command } from '../RESP/types';
import { transformStringDoubleArgument } from './generic-transformers';
export interface ZRangeStoreOptions {
BY?: 'SCORE' | 'LEX';
REV?: true;
LIMIT?: {
offset: number;
count: number;
};
}
export default {
IS_READ_ONLY: false,
/**
* Stores the result of a range operation on a sorted set into a new sorted set.
* @param parser - The Redis command parser.
* @param destination - Destination key where the result will be stored.
* @param source - Key of the source sorted set.
* @param min - Minimum index, score or lexicographical value.
* @param max - Maximum index, score or lexicographical value.
* @param options - Optional parameters for the range operation (BY, REV, LIMIT).
*/
parseCommand(
parser: CommandParser,
destination: RedisArgument,
source: RedisArgument,
min: RedisArgument | number,
max: RedisArgument | number,
options?: ZRangeStoreOptions
) {
parser.push('ZRANGESTORE');
parser.pushKey(destination);
parser.pushKey(source);
parser.push(
transformStringDoubleArgument(min),
transformStringDoubleArgument(max)
);
switch (options?.BY) {
case 'SCORE':
parser.push('BYSCORE');
break;
case 'LEX':
parser.push('BYLEX');
break;
}
if (options?.REV) {
parser.push('REV');
}
if (options?.LIMIT) {
parser.push('LIMIT', options.LIMIT.offset.toString(), options.LIMIT.count.toString());
}
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;