You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-03 04:01:40 +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
90 lines
2.8 KiB
TypeScript
90 lines
2.8 KiB
TypeScript
import { CommandParser } from '../client/parser';
|
|
import { RedisArgument, ArrayReply, NullReply, UnwrapReply, Command, TypeMapping } from '../RESP/types';
|
|
import { RedisVariadicArgument, StreamMessageRawReply, transformStreamMessageNullReply } from './generic-transformers';
|
|
|
|
/**
|
|
* Options for the XCLAIM command
|
|
*
|
|
* @property IDLE - Set the idle time (in milliseconds) for the claimed messages
|
|
* @property TIME - Set the last delivery time (Unix timestamp or Date)
|
|
* @property RETRYCOUNT - Set the retry counter for the claimed messages
|
|
* @property FORCE - Create the pending message entry even if the message doesn't exist
|
|
* @property LASTID - Update the consumer group last ID
|
|
*/
|
|
export interface XClaimOptions {
|
|
IDLE?: number;
|
|
TIME?: number | Date;
|
|
RETRYCOUNT?: number;
|
|
FORCE?: boolean;
|
|
LASTID?: RedisArgument;
|
|
}
|
|
|
|
export default {
|
|
IS_READ_ONLY: false,
|
|
/**
|
|
* Constructs the XCLAIM command to claim pending messages in a consumer group
|
|
*
|
|
* @param parser - The command parser
|
|
* @param key - The stream key
|
|
* @param group - The consumer group name
|
|
* @param consumer - The consumer name that will claim the messages
|
|
* @param minIdleTime - Minimum idle time in milliseconds for a message to be claimed
|
|
* @param id - One or more message IDs to claim
|
|
* @param options - Additional options for the claim operation
|
|
* @returns Array of claimed messages
|
|
* @see https://redis.io/commands/xclaim/
|
|
*/
|
|
parseCommand(
|
|
parser: CommandParser,
|
|
key: RedisArgument,
|
|
group: RedisArgument,
|
|
consumer: RedisArgument,
|
|
minIdleTime: number,
|
|
id: RedisVariadicArgument,
|
|
options?: XClaimOptions
|
|
) {
|
|
parser.push('XCLAIM');
|
|
parser.pushKey(key);
|
|
parser.push(group, consumer, minIdleTime.toString());
|
|
parser.pushVariadic(id);
|
|
|
|
if (options?.IDLE !== undefined) {
|
|
parser.push('IDLE', options.IDLE.toString());
|
|
}
|
|
|
|
if (options?.TIME !== undefined) {
|
|
parser.push(
|
|
'TIME',
|
|
(options.TIME instanceof Date ? options.TIME.getTime() : options.TIME).toString()
|
|
);
|
|
}
|
|
|
|
if (options?.RETRYCOUNT !== undefined) {
|
|
parser.push('RETRYCOUNT', options.RETRYCOUNT.toString());
|
|
}
|
|
|
|
if (options?.FORCE) {
|
|
parser.push('FORCE');
|
|
}
|
|
|
|
if (options?.LASTID !== undefined) {
|
|
parser.push('LASTID', options.LASTID);
|
|
}
|
|
},
|
|
/**
|
|
* Transforms the raw XCLAIM reply into an array of messages
|
|
*
|
|
* @param reply - Raw reply from Redis
|
|
* @param preserve - Preserve options (unused)
|
|
* @param typeMapping - Type mapping for message fields
|
|
* @returns Array of claimed messages with their fields
|
|
*/
|
|
transformReply(
|
|
reply: UnwrapReply<ArrayReply<StreamMessageRawReply | NullReply>>,
|
|
preserve?: any,
|
|
typeMapping?: TypeMapping
|
|
) {
|
|
return reply.map(transformStreamMessageNullReply.bind(undefined, typeMapping));
|
|
}
|
|
} as const satisfies Command;
|