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

12
packages/client/lib/commands/XDEL.ts
View File

@@ -2,8 +2,20 @@ import { CommandParser } from '../client/parser';
import { RedisArgument, NumberReply, Command } from '../RESP/types';
import { RedisVariadicArgument } from './generic-transformers';
/**
* Command for removing messages from a stream
*/
export default {
IS_READ_ONLY: false,
/**
* Constructs the XDEL command to remove one or more messages from a stream
*
* @param parser - The command parser
* @param key - The stream key
* @param id - One or more message IDs to delete
* @returns The number of messages actually deleted
* @see https://redis.io/commands/xdel/
*/
parseCommand(parser: CommandParser, key: RedisArgument, id: RedisVariadicArgument) {
parser.push('XDEL');
parser.pushKey(key);