redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-04 15:02:09 +03:00
Code Activity

(docs) add jsdoc comments to command parsers (#2984)

Browse Source 
* (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
This commit is contained in:
Bobby I.
2025-06-03 14:38:07 +03:00
committed by GitHub
parent e4a1ca467f
commit 20c16e0c2c
491 changed files with 3861 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
packages/client/lib/commands/SORT.ts
View File

@@ -1,6 +1,15 @@
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?: {
@@ -12,6 +21,13 @@ export interface SortOptions {
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,
@@ -52,6 +68,14 @@ export function parseSortArguments(
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);