1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-04 15:02:09 +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
974 B
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/lib/RESP/types';
export interface TDigestCreateOptions {
COMPRESSION?: number;
}
export default {
IS_READ_ONLY: false,
/**
* Creates a new t-digest sketch for storing distributions
* @param parser - The command parser
* @param key - The name of the t-digest sketch
* @param options - Optional parameters for sketch creation
* @param options.COMPRESSION - Compression parameter that affects performance and accuracy
*/
parseCommand(parser: CommandParser, key: RedisArgument, options?: TDigestCreateOptions) {
parser.push('TDIGEST.CREATE');
parser.pushKey(key);
if (options?.COMPRESSION !== undefined) {
parser.push('COMPRESSION', options.COMPRESSION.toString());
}
},
transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
} as const satisfies Command;