You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-04 15:02:09 +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:
@@ -1,14 +1,34 @@
|
||||
import { CommandParser } from '../client/parser';
|
||||
import { NumberReply, Command, RedisArgument } from '../RESP/types';
|
||||
|
||||
/**
|
||||
* Options for the XTRIM command
|
||||
*
|
||||
* @property strategyModifier - Exact ('=') or approximate ('~') trimming
|
||||
* @property LIMIT - Maximum number of entries to trim in one call (Redis 6.2+)
|
||||
*/
|
||||
export interface XTrimOptions {
|
||||
strategyModifier?: '=' | '~';
|
||||
/** added in 6.2 */
|
||||
LIMIT?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Command for trimming a stream to a specified length or minimum ID
|
||||
*/
|
||||
export default {
|
||||
IS_READ_ONLY: false,
|
||||
/**
|
||||
* Constructs the XTRIM command to trim a stream by length or minimum ID
|
||||
*
|
||||
* @param parser - The command parser
|
||||
* @param key - The stream key
|
||||
* @param strategy - Trim by maximum length (MAXLEN) or minimum ID (MINID)
|
||||
* @param threshold - Maximum length or minimum ID threshold
|
||||
* @param options - Additional options for trimming
|
||||
* @returns Number of entries removed from the stream
|
||||
* @see https://redis.io/commands/xtrim/
|
||||
*/
|
||||
parseCommand(
|
||||
parser: CommandParser,
|
||||
key: RedisArgument,
|
||||
|
Reference in New Issue
Block a user