You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-03 04:01:40 +03:00
d941ec5a4c
* chore: update Redis version from 8.2-RC1-pre to 8.2-rc1 * feat: implement XDELEX command for Redis 8.2 * feat: implement XACKDEL command for Redis 8.2 * refactor: create shared stream deletion types for Redis 8.2 commands * feat: add Redis 8.2 deletion policies to XTRIM command * feat: add Redis 8.2 deletion policies to XADD commands * fix: correct XDELEX command method name and test parameter
96 lines
2.8 KiB
TypeScript
96 lines
2.8 KiB
TypeScript
import { CommandParser } from '../client/parser';
|
|
import { RedisArgument, BlobStringReply, Command } from '../RESP/types';
|
|
import { StreamDeletionPolicy } from './common-stream.types';
|
|
import { Tail } from './generic-transformers';
|
|
|
|
/**
|
|
* Options for the XADD command
|
|
*
|
|
* @property TRIM - Optional trimming configuration
|
|
* @property TRIM.strategy - Trim strategy: MAXLEN (by length) or MINID (by ID)
|
|
* @property TRIM.strategyModifier - Exact ('=') or approximate ('~') trimming
|
|
* @property TRIM.threshold - Maximum stream length or minimum ID to retain
|
|
* @property TRIM.limit - Maximum number of entries to trim in one call
|
|
* @property TRIM.policy - Policy to apply when trimming entries (optional, defaults to KEEPREF)
|
|
*/
|
|
export interface XAddOptions {
|
|
TRIM?: {
|
|
strategy?: 'MAXLEN' | 'MINID';
|
|
strategyModifier?: '=' | '~';
|
|
threshold: number;
|
|
limit?: number;
|
|
/** added in 8.2 */
|
|
policy?: StreamDeletionPolicy;
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Parses arguments for the XADD command
|
|
*
|
|
* @param optional - Optional command modifier
|
|
* @param parser - The command parser
|
|
* @param key - The stream key
|
|
* @param id - Message ID (* for auto-generation)
|
|
* @param message - Key-value pairs representing the message fields
|
|
* @param options - Additional options for stream trimming
|
|
*/
|
|
export function parseXAddArguments(
|
|
optional: RedisArgument | undefined,
|
|
parser: CommandParser,
|
|
key: RedisArgument,
|
|
id: RedisArgument,
|
|
message: Record<string, RedisArgument>,
|
|
options?: XAddOptions
|
|
) {
|
|
parser.push('XADD');
|
|
parser.pushKey(key);
|
|
if (optional) {
|
|
parser.push(optional);
|
|
}
|
|
|
|
if (options?.TRIM) {
|
|
if (options.TRIM.strategy) {
|
|
parser.push(options.TRIM.strategy);
|
|
}
|
|
|
|
if (options.TRIM.strategyModifier) {
|
|
parser.push(options.TRIM.strategyModifier);
|
|
}
|
|
|
|
parser.push(options.TRIM.threshold.toString());
|
|
|
|
if (options.TRIM.limit) {
|
|
parser.push('LIMIT', options.TRIM.limit.toString());
|
|
}
|
|
|
|
if (options.TRIM.policy) {
|
|
parser.push(options.TRIM.policy);
|
|
}
|
|
}
|
|
|
|
parser.push(id);
|
|
|
|
for (const [key, value] of Object.entries(message)) {
|
|
parser.push(key, value);
|
|
}
|
|
}
|
|
|
|
export default {
|
|
IS_READ_ONLY: false,
|
|
/**
|
|
* Constructs the XADD command to append a new entry to a stream
|
|
*
|
|
* @param parser - The command parser
|
|
* @param key - The stream key
|
|
* @param id - Message ID (* for auto-generation)
|
|
* @param message - Key-value pairs representing the message fields
|
|
* @param options - Additional options for stream trimming
|
|
* @returns The ID of the added entry
|
|
* @see https://redis.io/commands/xadd/
|
|
*/
|
|
parseCommand(...args: Tail<Parameters<typeof parseXAddArguments>>) {
|
|
return parseXAddArguments(undefined, ...args);
|
|
},
|
|
transformReply: undefined as unknown as () => BlobStringReply
|
|
} as const satisfies Command;
|