1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
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

27 lines
874 B
TypeScript

import { CommandParser } from '../client/parser';
import { ArrayReply, BlobStringReply, Command } from '../RESP/types';
import { ZKeys, parseZKeysArguments } from './generic-transformers';
export interface ZUnionOptions {
AGGREGATE?: 'SUM' | 'MIN' | 'MAX';
}
export default {
IS_READ_ONLY: true,
/**
* Returns the union of multiple sorted sets.
* @param parser - The Redis command parser.
* @param keys - Keys of the sorted sets to combine.
* @param options - Optional parameters for the union operation.
*/
parseCommand(parser: CommandParser, keys: ZKeys, options?: ZUnionOptions) {
parser.push('ZUNION');
parseZKeysArguments(parser, keys);
if (options?.AGGREGATE) {
parser.push('AGGREGATE', options.AGGREGATE);
}
},
transformReply: undefined as unknown as () => ArrayReply<BlobStringReply>
} as const satisfies Command;