redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-09 00:22:08 +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

10
packages/bloom/lib/commands/top-k/RESERVE.ts
View File

@@ -9,6 +9,16 @@ export interface TopKReserveOptions {
export default {
IS_READ_ONLY: false,
/**
* Creates a new Top-K filter with specified parameters
* @param parser - The command parser
* @param key - The name of the Top-K filter
* @param topK - Number of top occurring items to keep
* @param options - Optional parameters for filter configuration
* @param options.width - Number of counters in each array
* @param options.depth - Number of counter-arrays
* @param options.decay - Counter decay factor
*/
parseCommand(parser: CommandParser, key: RedisArgument, topK: number, options?: TopKReserveOptions) {
parser.push('TOPK.RESERVE');
parser.pushKey(key);