You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-03 04:01:40 +03:00
20c16e0c2c
* (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
85 lines
2.0 KiB
TypeScript
85 lines
2.0 KiB
TypeScript
import { CommandParser } from '../client/parser';
|
|
import { RedisArgument, ArrayReply, BlobStringReply, Command } from '../RESP/types';
|
|
|
|
/**
|
|
* Options for the SORT command
|
|
*
|
|
* @property BY - Pattern for external key to sort by
|
|
* @property LIMIT - Offset and count for results pagination
|
|
* @property GET - Pattern(s) for retrieving external keys
|
|
* @property DIRECTION - Sort direction: ASC (ascending) or DESC (descending)
|
|
* @property ALPHA - Sort lexicographically instead of numerically
|
|
*/
|
|
export interface SortOptions {
|
|
BY?: RedisArgument;
|
|
LIMIT?: {
|
|
offset: number;
|
|
count: number;
|
|
};
|
|
GET?: RedisArgument | Array<RedisArgument>;
|
|
DIRECTION?: 'ASC' | 'DESC';
|
|
ALPHA?: boolean;
|
|
}
|
|
|
|
/**
|
|
* Parses sort arguments for the SORT command
|
|
*
|
|
* @param parser - The command parser
|
|
* @param key - The key to sort
|
|
* @param options - Sort options
|
|
*/
|
|
export function parseSortArguments(
|
|
parser: CommandParser,
|
|
key: RedisArgument,
|
|
options?: SortOptions
|
|
) {
|
|
parser.pushKey(key);
|
|
|
|
if (options?.BY) {
|
|
parser.push('BY', options.BY);
|
|
}
|
|
|
|
if (options?.LIMIT) {
|
|
parser.push(
|
|
'LIMIT',
|
|
options.LIMIT.offset.toString(),
|
|
options.LIMIT.count.toString()
|
|
);
|
|
}
|
|
|
|
if (options?.GET) {
|
|
if (Array.isArray(options.GET)) {
|
|
for (const pattern of options.GET) {
|
|
parser.push('GET', pattern);
|
|
}
|
|
} else {
|
|
parser.push('GET', options.GET);
|
|
}
|
|
}
|
|
|
|
if (options?.DIRECTION) {
|
|
parser.push(options.DIRECTION);
|
|
}
|
|
|
|
if (options?.ALPHA) {
|
|
parser.push('ALPHA');
|
|
}
|
|
}
|
|
|
|
export default {
|
|
IS_READ_ONLY: true,
|
|
/**
|
|
* Constructs the SORT command
|
|
*
|
|
* @param parser - The command parser
|
|
* @param key - The key to sort (list, set, or sorted set)
|
|
* @param options - Sort options
|
|
* @see https://redis.io/commands/sort/
|
|
*/
|
|
parseCommand(parser: CommandParser, key: RedisArgument, options?: SortOptions) {
|
|
parser.push('SORT');
|
|
parseSortArguments(parser, key, options);
|
|
},
|
|
transformReply: undefined as unknown as () => ArrayReply<BlobStringReply>
|
|
} as const satisfies Command;
|