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/ZRANGEBYSCORE.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

45 lines
1.3 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, ArrayReply, BlobStringReply, Command } from '../RESP/types';
import { transformStringDoubleArgument } from './generic-transformers';
export interface ZRangeByScoreOptions {
LIMIT?: {
offset: number;
count: number;
};
}
export declare function transformReply(): Array<RedisArgument>;
export default {
CACHEABLE: true,
IS_READ_ONLY: true,
/**
* Returns all the elements in the sorted set with a score between min and max.
* @param parser - The Redis command parser.
* @param key - Key of the sorted set.
* @param min - Minimum score.
* @param max - Maximum score.
* @param options - Optional parameters including LIMIT.
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
min: string | number,
max: string | number,
options?: ZRangeByScoreOptions
) {
parser.push('ZRANGEBYSCORE');
parser.pushKey(key);
parser.push(
transformStringDoubleArgument(min),
transformStringDoubleArgument(max)
);
if (options?.LIMIT) {
parser.push('LIMIT', options.LIMIT.offset.toString(), options.LIMIT.count.toString());
}
},
transformReply: undefined as unknown as () => ArrayReply<BlobStringReply>
} as const satisfies Command;