redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +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

15
packages/client/lib/commands/XCLAIM_JUSTID.ts
View File

@@ -1,12 +1,27 @@
import { ArrayReply, BlobStringReply, Command } from '../RESP/types';
import XCLAIM from './XCLAIM';
/**
* Command variant for XCLAIM that returns only message IDs
*/
export default {
IS_READ_ONLY: XCLAIM.IS_READ_ONLY,
/**
* Constructs the XCLAIM command with JUSTID option to get only message IDs
*
* @param args - Same parameters as XCLAIM command
* @returns Array of successfully claimed message IDs
* @see https://redis.io/commands/xclaim/
*/
parseCommand(...args: Parameters<typeof XCLAIM.parseCommand>) {
const parser = args[0];
XCLAIM.parseCommand(...args);
parser.push('JUSTID');
},
/**
* Transforms the XCLAIM JUSTID reply into an array of message IDs
*
* @returns Array of claimed message IDs
*/
transformReply: undefined as unknown as () => ArrayReply<BlobStringReply>
} as const satisfies Command;