redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-04 15:02:09 +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/XADD.ts
View File

@@ -2,6 +2,15 @@ import { CommandParser } from '../client/parser';
import { RedisArgument, BlobStringReply, Command } from '../RESP/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
*/
export interface XAddOptions {
TRIM?: {
strategy?: 'MAXLEN' | 'MINID';
@@ -11,6 +20,16 @@ export interface XAddOptions {
};
}
/**
* 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,
@@ -50,6 +69,17 @@ export function parseXAddArguments(
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);
},