You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-10 11:43:01 +03:00
20c16e0c2c
* (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
55 lines
1.5 KiB
TypeScript
55 lines
1.5 KiB
TypeScript
import { CommandParser } from '../client/parser';
|
|
import { NumberReply, Command, RedisArgument } from '../RESP/types';
|
|
|
|
/**
|
|
* Options for the XTRIM command
|
|
*
|
|
* @property strategyModifier - Exact ('=') or approximate ('~') trimming
|
|
* @property LIMIT - Maximum number of entries to trim in one call (Redis 6.2+)
|
|
*/
|
|
export interface XTrimOptions {
|
|
strategyModifier?: '=' | '~';
|
|
/** added in 6.2 */
|
|
LIMIT?: number;
|
|
}
|
|
|
|
/**
|
|
* Command for trimming a stream to a specified length or minimum ID
|
|
*/
|
|
export default {
|
|
IS_READ_ONLY: false,
|
|
/**
|
|
* Constructs the XTRIM command to trim a stream by length or minimum ID
|
|
*
|
|
* @param parser - The command parser
|
|
* @param key - The stream key
|
|
* @param strategy - Trim by maximum length (MAXLEN) or minimum ID (MINID)
|
|
* @param threshold - Maximum length or minimum ID threshold
|
|
* @param options - Additional options for trimming
|
|
* @returns Number of entries removed from the stream
|
|
* @see https://redis.io/commands/xtrim/
|
|
*/
|
|
parseCommand(
|
|
parser: CommandParser,
|
|
key: RedisArgument,
|
|
strategy: 'MAXLEN' | 'MINID',
|
|
threshold: number,
|
|
options?: XTrimOptions
|
|
) {
|
|
parser.push('XTRIM')
|
|
parser.pushKey(key);
|
|
parser.push(strategy);
|
|
|
|
if (options?.strategyModifier) {
|
|
parser.push(options.strategyModifier);
|
|
}
|
|
|
|
parser.push(threshold.toString());
|
|
|
|
if (options?.LIMIT) {
|
|
parser.push('LIMIT', options.LIMIT.toString());
|
|
}
|
|
},
|
|
transformReply: undefined as unknown as () => NumberReply
|
|
} as const satisfies Command;
|