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

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

@@ -2,6 +2,12 @@ import { CommandParser } from '../client/parser';
import { Command, RedisArgument, ReplyUnion } from '../RESP/types';
import { transformStreamsMessagesReplyResp2 } from './generic-transformers';
/**
* Structure representing a stream to read from
*
* @property key - The stream key
* @property id - The message ID to start reading from
*/
export interface XReadStream {
key: RedisArgument;
id: RedisArgument;
@@ -9,6 +15,12 @@ export interface XReadStream {
export type XReadStreams = Array<XReadStream> | XReadStream;
/**
* Helper function to push stream keys and IDs to the command parser
*
* @param parser - The command parser
* @param streams - Single stream or array of streams to read from
*/
export function pushXReadStreams(parser: CommandParser, streams: XReadStreams) {
parser.push('STREAMS');
@@ -25,6 +37,12 @@ export function pushXReadStreams(parser: CommandParser, streams: XReadStreams) {
}
}
/**
* Options for the XREAD command
*
* @property COUNT - Limit the number of entries returned per stream
* @property BLOCK - Milliseconds to block waiting for new entries (0 for indefinite)
*/
export interface XReadOptions {
COUNT?: number;
BLOCK?: number;
@@ -32,6 +50,15 @@ export interface XReadOptions {
export default {
IS_READ_ONLY: true,
/**
* Constructs the XREAD command to read messages from one or more streams
*
* @param parser - The command parser
* @param streams - Single stream or array of streams to read from
* @param options - Additional options for reading streams
* @returns Array of stream entries, each containing the stream name and its messages
* @see https://redis.io/commands/xread/
*/
parseCommand(parser: CommandParser, streams: XReadStreams, options?: XReadOptions) {
parser.push('XREAD');
@@ -45,6 +72,9 @@ export default {
pushXReadStreams(parser, streams);
},
/**
* Transform functions for different RESP versions
*/
transformReply: {
2: transformStreamsMessagesReplyResp2,
3: undefined as unknown as () => ReplyUnion