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

17
packages/client/lib/commands/XGROUP_CREATE.ts
View File

@@ -1,6 +1,12 @@
import { CommandParser } from '../client/parser';
import { RedisArgument, SimpleStringReply, Command } from '../RESP/types';
/**
* Options for creating a consumer group
*
* @property MKSTREAM - Create the stream if it doesn't exist
* @property ENTRIESREAD - Set the number of entries that were read in this consumer group (Redis 7.0+)
*/
export interface XGroupCreateOptions {
MKSTREAM?: boolean;
/**
@@ -11,6 +17,17 @@ export interface XGroupCreateOptions {
export default {
IS_READ_ONLY: false,
/**
* Constructs the XGROUP CREATE command to create a consumer group for a stream
*
* @param parser - The command parser
* @param key - The stream key
* @param group - Name of the consumer group
* @param id - ID of the last delivered item in the stream ('$' for last item, '0' for all items)
* @param options - Additional options for group creation
* @returns 'OK' if successful
* @see https://redis.io/commands/xgroup-create/
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,