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

@@ -17,6 +17,10 @@ export type TsMRangeWithLabelsGroupByRawReply3 = MapReply<
]>
>;
/**
* Creates a function that parses arguments for multi-range commands with selected labels and grouping
* @param command - The command name to use (TS.MRANGE or TS.MREVRANGE)
*/
export function createMRangeSelectedLabelsGroupByTransformArguments(
command: RedisArgument
) {
@@ -47,6 +51,16 @@ export function createMRangeSelectedLabelsGroupByTransformArguments(
export default {
IS_READ_ONLY: true,
/**
* Gets samples for time series matching a filter with selected labels and grouping
* @param parser - The command parser
* @param fromTimestamp - Start timestamp for range
* @param toTimestamp - End timestamp for range
* @param selectedLabels - Labels to include in the output
* @param filter - Filter to match time series keys
* @param groupBy - Group by parameters
* @param options - Optional parameters for the command
*/
parseCommand: createMRangeSelectedLabelsGroupByTransformArguments('TS.MRANGE'),
transformReply: {
2: MRANGE_SELECTED_LABELS.transformReply[2],