You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-06 02:15:48 +03:00
(docs) add jsdoc comments to command parsers (#2984)
* (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:
@@ -2,8 +2,18 @@ import { BlobStringReply, NullReply, Command } from '../RESP/types';
|
||||
import { Tail } from './generic-transformers';
|
||||
import { parseXAddArguments } from './XADD';
|
||||
|
||||
/**
|
||||
* Command for adding entries to an existing stream without creating it if it doesn't exist
|
||||
*/
|
||||
export default {
|
||||
IS_READ_ONLY: false,
|
||||
/**
|
||||
* Constructs the XADD command with NOMKSTREAM option to append a new entry to an existing stream
|
||||
*
|
||||
* @param args - Arguments tuple containing parser, key, id, message, and options
|
||||
* @returns The ID of the added entry, or null if the stream doesn't exist
|
||||
* @see https://redis.io/commands/xadd/
|
||||
*/
|
||||
parseCommand(...args: Tail<Parameters<typeof parseXAddArguments>>) {
|
||||
return parseXAddArguments('NOMKSTREAM', ...args);
|
||||
},
|
||||
|
Reference in New Issue
Block a user