redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-12-14 09:42:12 +03:00
Code Activity

(docs) add jsdoc comments to command parsers (#2984)

Browse Source 
* (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
This commit is contained in:
Bobby I.
2025-06-03 14:38:07 +03:00
committed by GitHub
parent e4a1ca467f
commit 20c16e0c2c
491 changed files with 3861 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
packages/client/lib/commands/XCLAIM.ts
View File

@@ -2,6 +2,15 @@ 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;
@@ -12,6 +21,19 @@ export interface XClaimOptions {
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,
@@ -49,6 +71,14 @@ export default {
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,