1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +03:00

(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
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

View File

@@ -25,6 +25,11 @@ export interface TsMRangeGroupBy {
REDUCE: TimeSeriesReducer;
}
/**
* Adds GROUPBY arguments to command
* @param parser - The command parser
* @param groupBy - Group by parameters
*/
export function parseGroupByArguments(parser: CommandParser, groupBy: TsMRangeGroupBy) {
parser.push('GROUPBY', groupBy.label, 'REDUCE', groupBy.REDUCE);
}
@@ -51,6 +56,10 @@ export type TsMRangeGroupByRawReply3 = MapReply<
]>
>;
/**
* Creates a function that parses arguments for multi-range commands with grouping
* @param command - The command name to use (TS.MRANGE or TS.MREVRANGE)
*/
export function createTransformMRangeGroupByArguments(command: RedisArgument) {
return (
parser: CommandParser,
@@ -69,6 +78,10 @@ export function createTransformMRangeGroupByArguments(command: RedisArgument) {
};
}
/**
* Extracts source keys from RESP3 metadata reply
* @param raw - Raw metadata from RESP3 reply
*/
export function extractResp3MRangeSources(raw: TsMRangeGroupByRawMetadataReply3) {
const unwrappedMetadata2 = raw as unknown as UnwrapReply<typeof raw>;
if (unwrappedMetadata2 instanceof Map) {
@@ -82,6 +95,15 @@ export function extractResp3MRangeSources(raw: TsMRangeGroupByRawMetadataReply3)
export default {
IS_READ_ONLY: true,
/**
* Gets samples for time series matching a filter within a time range with grouping
* @param parser - The command parser
* @param fromTimestamp - Start timestamp for range
* @param toTimestamp - End timestamp for range
* @param filter - Filter to match time series keys
* @param groupBy - Group by parameters
* @param options - Optional parameters for the command
*/
parseCommand: createTransformMRangeGroupByArguments('TS.MRANGE'),
transformReply: {
2(reply: TsMRangeGroupByRawReply2, _?: any, typeMapping?: TypeMapping) {