@redis/bloom - npm Package Compare versions

Comparing version 5.5.5 to 5.5.6

dist/lib/commands/bloom/ADD.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Adds an item to a Bloom Filter
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter
+     * @param item - The item to add to the filter
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, item: RedisArgument) => void;
@@ -7,0 +13,0 @@ readonly transformReply: {

dist/lib/commands/bloom/ADD.js

@@ -6,2 +6,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Adds an item to a Bloom Filter
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter
+     * @param item - The item to add to the filter
+     */
     parseCommand(parser, key, item) {
@@ -8,0 +14,0 @@ parser.push('BF.ADD');

dist/lib/commands/bloom/CARD.d.ts

@@ -5,2 +5,7 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns the cardinality (number of items) in a Bloom Filter
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter to query
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument) => void;
@@ -7,0 +12,0 @@ readonly transformReply: () => NumberReply;

dist/lib/commands/bloom/CARD.js

@@ -5,2 +5,7 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns the cardinality (number of items) in a Bloom Filter
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter to query
+     */
     parseCommand(parser, key) {
@@ -7,0 +12,0 @@ parser.push('BF.CARD');

dist/lib/commands/bloom/EXISTS.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Checks if an item exists in a Bloom Filter
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter
+     * @param item - The item to check for existence
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, item: RedisArgument) => void;
@@ -7,0 +13,0 @@ readonly transformReply: {

dist/lib/commands/bloom/EXISTS.js

@@ -6,2 +6,8 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Checks if an item exists in a Bloom Filter
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter
+     * @param item - The item to check for existence
+     */
     parseCommand(parser, key, item) {
@@ -8,0 +14,0 @@ parser.push('BF.EXISTS');

dist/lib/commands/bloom/INFO.d.ts

@@ -27,2 +27,7 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns information about a Bloom Filter, including capacity, size, number of filters, items inserted, and expansion rate
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter to get information about
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument) => void;
@@ -29,0 +34,0 @@ readonly transformReply: {

dist/lib/commands/bloom/INFO.js

@@ -6,2 +6,7 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns information about a Bloom Filter, including capacity, size, number of filters, items inserted, and expansion rate
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter to get information about
+     */
     parseCommand(parser, key) {
@@ -8,0 +13,0 @@ parser.push('BF.INFO');

dist/lib/commands/bloom/INSERT.d.ts

@@ -13,2 +13,14 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Adds one or more items to a Bloom Filter, creating it if it does not exist
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter
+     * @param items - One or more items to add to the filter
+     * @param options - Optional parameters for filter creation
+     * @param options.CAPACITY - Desired capacity for a new filter
+     * @param options.ERROR - Desired error rate for a new filter
+     * @param options.EXPANSION - Expansion rate for a new filter
+     * @param options.NOCREATE - If true, prevents automatic filter creation
+     * @param options.NONSCALING - Prevents the filter from creating additional sub-filters
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument, options?: BfInsertOptions) => void;
@@ -15,0 +27,0 @@ readonly transformReply: {

dist/lib/commands/bloom/INSERT.js

@@ -6,2 +6,14 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Adds one or more items to a Bloom Filter, creating it if it does not exist
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter
+     * @param items - One or more items to add to the filter
+     * @param options - Optional parameters for filter creation
+     * @param options.CAPACITY - Desired capacity for a new filter
+     * @param options.ERROR - Desired error rate for a new filter
+     * @param options.EXPANSION - Expansion rate for a new filter
+     * @param options.NOCREATE - If true, prevents automatic filter creation
+     * @param options.NONSCALING - Prevents the filter from creating additional sub-filters
+     */
     parseCommand(parser, key, items, options) {
@@ -8,0 +20,0 @@ parser.push('BF.INSERT');

dist/lib/commands/bloom/LOADCHUNK.d.ts

@@ -5,2 +5,9 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Restores a Bloom Filter chunk previously saved using SCANDUMP
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter to restore
+     * @param iterator - Iterator value from the SCANDUMP command
+     * @param chunk - Data chunk from the SCANDUMP command
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, iterator: number, chunk: RedisArgument) => void;
@@ -7,0 +14,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/bloom/LOADCHUNK.js

@@ -5,2 +5,9 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Restores a Bloom Filter chunk previously saved using SCANDUMP
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter to restore
+     * @param iterator - Iterator value from the SCANDUMP command
+     * @param chunk - Data chunk from the SCANDUMP command
+     */
     parseCommand(parser, key, iterator, chunk) {
@@ -7,0 +14,0 @@ parser.push('BF.LOADCHUNK');

dist/lib/commands/bloom/MADD.d.ts

@@ -6,2 +6,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Adds multiple items to a Bloom Filter in a single call
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter
+     * @param items - One or more items to add to the filter
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) => void;
@@ -8,0 +14,0 @@ readonly transformReply: {

dist/lib/commands/bloom/MADD.js

@@ -6,2 +6,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Adds multiple items to a Bloom Filter in a single call
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter
+     * @param items - One or more items to add to the filter
+     */
     parseCommand(parser, key, items) {
@@ -8,0 +14,0 @@ parser.push('BF.MADD');

dist/lib/commands/bloom/MEXISTS.d.ts

@@ -6,2 +6,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Checks if multiple items exist in a Bloom Filter in a single call
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter
+     * @param items - One or more items to check for existence
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) => void;
@@ -8,0 +14,0 @@ readonly transformReply: {

dist/lib/commands/bloom/MEXISTS.js

@@ -6,2 +6,8 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Checks if multiple items exist in a Bloom Filter in a single call
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter
+     * @param items - One or more items to check for existence
+     */
     parseCommand(parser, key, items) {
@@ -8,0 +14,0 @@ parser.push('BF.MEXISTS');

dist/lib/commands/bloom/RESERVE.d.ts

@@ -9,2 +9,12 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Creates an empty Bloom Filter with a given desired error ratio and initial capacity
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter to create
+     * @param errorRate - The desired probability for false positives (between 0 and 1)
+     * @param capacity - The number of entries intended to be added to the filter
+     * @param options - Optional parameters to tune the filter
+     * @param options.EXPANSION - Expansion rate for the filter
+     * @param options.NONSCALING - Prevents the filter from creating additional sub-filters
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, errorRate: number, capacity: number, options?: BfReserveOptions) => void;
@@ -11,0 +21,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/bloom/RESERVE.js

@@ -5,2 +5,12 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Creates an empty Bloom Filter with a given desired error ratio and initial capacity
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter to create
+     * @param errorRate - The desired probability for false positives (between 0 and 1)
+     * @param capacity - The number of entries intended to be added to the filter
+     * @param options - Optional parameters to tune the filter
+     * @param options.EXPANSION - Expansion rate for the filter
+     * @param options.NONSCALING - Prevents the filter from creating additional sub-filters
+     */
     parseCommand(parser, key, errorRate, capacity, options) {
@@ -7,0 +17,0 @@ parser.push('BF.RESERVE');

dist/lib/commands/bloom/SCANDUMP.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Begins an incremental save of a Bloom Filter. This is useful for large filters that can't be saved at once
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter to save
+     * @param iterator - Iterator value; Start at 0, and use the iterator from the response for the next chunk
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, iterator: number) => void;
@@ -7,0 +13,0 @@ readonly transformReply: (this: void, reply: [NumberReply<number>, BlobStringReply<string>]) => {

dist/lib/commands/bloom/SCANDUMP.js

@@ -5,2 +5,8 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Begins an incremental save of a Bloom Filter. This is useful for large filters that can't be saved at once
+     * @param parser - The command parser
+     * @param key - The name of the Bloom filter to save
+     * @param iterator - Iterator value; Start at 0, and use the iterator from the response for the next chunk
+     */
     parseCommand(parser, key, iterator) {
@@ -7,0 +13,0 @@ parser.push('BF.SCANDUMP');

dist/lib/commands/count-min-sketch/INCRBY.d.ts

@@ -9,2 +9,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Increases the count of one or more items in a Count-Min Sketch
+     * @param parser - The command parser
+     * @param key - The name of the sketch
+     * @param items - A single item or array of items to increment, each with an item and increment value
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, items: BfIncrByItem | Array<BfIncrByItem>) => void;
@@ -11,0 +17,0 @@ readonly transformReply: () => ArrayReply<NumberReply>;

dist/lib/commands/count-min-sketch/INCRBY.js

@@ -5,2 +5,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Increases the count of one or more items in a Count-Min Sketch
+     * @param parser - The command parser
+     * @param key - The name of the sketch
+     * @param items - A single item or array of items to increment, each with an item and increment value
+     */
     parseCommand(parser, key, items) {
@@ -7,0 +13,0 @@ parser.push('CMS.INCRBY');

dist/lib/commands/count-min-sketch/INFO.d.ts

@@ -24,2 +24,7 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns width, depth, and total count of items in a Count-Min Sketch
+     * @param parser - The command parser
+     * @param key - The name of the sketch to get information about
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument) => void;
@@ -26,0 +31,0 @@ readonly transformReply: {

dist/lib/commands/count-min-sketch/INFO.js

@@ -6,2 +6,7 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns width, depth, and total count of items in a Count-Min Sketch
+     * @param parser - The command parser
+     * @param key - The name of the sketch to get information about
+     */
     parseCommand(parser, key) {
@@ -8,0 +13,0 @@ parser.push('CMS.INFO');

dist/lib/commands/count-min-sketch/INITBYDIM.d.ts

@@ -5,2 +5,9 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Initialize a Count-Min Sketch using width and depth parameters
+     * @param parser - The command parser
+     * @param key - The name of the sketch
+     * @param width - Number of counters in each array (must be a multiple of 2)
+     * @param depth - Number of counter arrays (determines accuracy of estimates)
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, width: number, depth: number) => void;
@@ -7,0 +14,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/count-min-sketch/INITBYDIM.js

@@ -5,2 +5,9 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Initialize a Count-Min Sketch using width and depth parameters
+     * @param parser - The command parser
+     * @param key - The name of the sketch
+     * @param width - Number of counters in each array (must be a multiple of 2)
+     * @param depth - Number of counter arrays (determines accuracy of estimates)
+     */
     parseCommand(parser, key, width, depth) {
@@ -7,0 +14,0 @@ parser.push('CMS.INITBYDIM');

dist/lib/commands/count-min-sketch/INITBYPROB.d.ts

@@ -5,2 +5,9 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Initialize a Count-Min Sketch using error rate and probability parameters
+     * @param parser - The command parser
+     * @param key - The name of the sketch
+     * @param error - Estimate error, as a decimal between 0 and 1
+     * @param probability - The desired probability for inflated count, as a decimal between 0 and 1
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, error: number, probability: number) => void;
@@ -7,0 +14,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/count-min-sketch/INITBYPROB.js

@@ -5,2 +5,9 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Initialize a Count-Min Sketch using error rate and probability parameters
+     * @param parser - The command parser
+     * @param key - The name of the sketch
+     * @param error - Estimate error, as a decimal between 0 and 1
+     * @param probability - The desired probability for inflated count, as a decimal between 0 and 1
+     */
     parseCommand(parser, key, error, probability) {
@@ -7,0 +14,0 @@ parser.push('CMS.INITBYPROB');

dist/lib/commands/count-min-sketch/MERGE.d.ts

@@ -10,2 +10,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Merges multiple Count-Min Sketches into a single sketch, with optional weights
+     * @param parser - The command parser
+     * @param destination - The name of the destination sketch
+     * @param source - Array of sketch names or array of sketches with weights
+     */
     readonly parseCommand: (this: void, parser: CommandParser, destination: RedisArgument, source: BfMergeSketches) => void;
@@ -12,0 +18,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/count-min-sketch/MERGE.js

@@ -5,2 +5,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Merges multiple Count-Min Sketches into a single sketch, with optional weights
+     * @param parser - The command parser
+     * @param destination - The name of the destination sketch
+     * @param source - Array of sketch names or array of sketches with weights
+     */
     parseCommand(parser, destination, source) {
@@ -7,0 +13,0 @@ parser.push('CMS.MERGE');

dist/lib/commands/count-min-sketch/QUERY.d.ts

@@ -6,2 +6,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns the count for one or more items in a Count-Min Sketch
+     * @param parser - The command parser
+     * @param key - The name of the sketch
+     * @param items - One or more items to get counts for
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) => void;
@@ -8,0 +14,0 @@ readonly transformReply: () => ArrayReply<NumberReply>;

dist/lib/commands/count-min-sketch/QUERY.js

@@ -5,2 +5,8 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns the count for one or more items in a Count-Min Sketch
+     * @param parser - The command parser
+     * @param key - The name of the sketch
+     * @param items - One or more items to get counts for
+     */
     parseCommand(parser, key, items) {
@@ -7,0 +13,0 @@ parser.push('CMS.QUERY');

dist/lib/commands/cuckoo/ADD.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Adds an item to a Cuckoo Filter, creating the filter if it does not exist
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param item - The item to add to the filter
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, item: RedisArgument) => void;
@@ -7,0 +13,0 @@ readonly transformReply: {

dist/lib/commands/cuckoo/ADD.js

@@ -6,2 +6,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Adds an item to a Cuckoo Filter, creating the filter if it does not exist
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param item - The item to add to the filter
+     */
     parseCommand(parser, key, item) {
@@ -8,0 +14,0 @@ parser.push('CF.ADD');

dist/lib/commands/cuckoo/ADDNX.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Adds an item to a Cuckoo Filter only if it does not exist
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param item - The item to add to the filter if it doesn't exist
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, item: RedisArgument) => void;
@@ -7,0 +13,0 @@ readonly transformReply: {

dist/lib/commands/cuckoo/ADDNX.js

@@ -6,2 +6,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Adds an item to a Cuckoo Filter only if it does not exist
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param item - The item to add to the filter if it doesn't exist
+     */
     parseCommand(parser, key, item) {
@@ -8,0 +14,0 @@ parser.push('CF.ADDNX');

dist/lib/commands/cuckoo/COUNT.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns the number of times an item appears in a Cuckoo Filter
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param item - The item to count occurrences of
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, item: RedisArgument) => void;
@@ -7,0 +13,0 @@ readonly transformReply: () => NumberReply;

dist/lib/commands/cuckoo/COUNT.js

@@ -5,2 +5,8 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns the number of times an item appears in a Cuckoo Filter
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param item - The item to count occurrences of
+     */
     parseCommand(parser, key, item) {
@@ -7,0 +13,0 @@ parser.push('CF.COUNT');

dist/lib/commands/cuckoo/DEL.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Removes an item from a Cuckoo Filter if it exists
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param item - The item to remove from the filter
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, item: RedisArgument) => void;
@@ -7,0 +13,0 @@ readonly transformReply: {

dist/lib/commands/cuckoo/DEL.js

@@ -6,2 +6,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Removes an item from a Cuckoo Filter if it exists
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param item - The item to remove from the filter
+     */
     parseCommand(parser, key, item) {
@@ -8,0 +14,0 @@ parser.push('CF.DEL');

dist/lib/commands/cuckoo/EXISTS.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Checks if an item exists in a Cuckoo Filter
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param item - The item to check for existence
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, item: RedisArgument) => void;
@@ -7,0 +13,0 @@ readonly transformReply: {

dist/lib/commands/cuckoo/EXISTS.js

@@ -6,2 +6,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Checks if an item exists in a Cuckoo Filter
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param item - The item to check for existence
+     */
     parseCommand(parser, key, item) {
@@ -8,0 +14,0 @@ parser.push('CF.EXISTS');

dist/lib/commands/cuckoo/INFO.d.ts

@@ -39,2 +39,7 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns detailed information about a Cuckoo Filter including size, buckets, filters count, items statistics and configuration
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter to get information about
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument) => void;
@@ -41,0 +46,0 @@ readonly transformReply: {

dist/lib/commands/cuckoo/INFO.js

@@ -6,2 +6,7 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns detailed information about a Cuckoo Filter including size, buckets, filters count, items statistics and configuration
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter to get information about
+     */
     parseCommand(parser, key) {
@@ -8,0 +13,0 @@ parser.push('CF.INFO');

dist/lib/commands/cuckoo/INSERT.d.ts

@@ -11,2 +11,11 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Adds one or more items to a Cuckoo Filter, creating it if it does not exist
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param items - One or more items to add to the filter
+     * @param options - Optional parameters for filter creation
+     * @param options.CAPACITY - The number of entries intended to be added to the filter
+     * @param options.NOCREATE - If true, prevents automatic filter creation
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument, options?: CfInsertOptions | undefined) => void;
@@ -13,0 +22,0 @@ readonly transformReply: {

dist/lib/commands/cuckoo/INSERT.js

@@ -19,2 +19,11 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Adds one or more items to a Cuckoo Filter, creating it if it does not exist
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter
+     * @param items - One or more items to add to the filter
+     * @param options - Optional parameters for filter creation
+     * @param options.CAPACITY - The number of entries intended to be added to the filter
+     * @param options.NOCREATE - If true, prevents automatic filter creation
+     */
     parseCommand(...args) {
@@ -21,0 +30,0 @@ args[0].push('CF.INSERT');

dist/lib/commands/cuckoo/INSERTNX.d.ts

@@ -0,1 +1,10 @@
+/**
+ * Adds one or more items to a Cuckoo Filter only if they do not exist yet, creating the filter if needed
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter
+ * @param items - One or more items to add to the filter
+ * @param options - Optional parameters for filter creation
+ * @param options.CAPACITY - The number of entries intended to be added to the filter
+ * @param options.NOCREATE - If true, prevents automatic filter creation
+ */
 declare const _default: {
@@ -2,0 +11,0 @@ readonly IS_READ_ONLY: false;

dist/lib/commands/cuckoo/INSERTNX.js

@@ -27,2 +27,11 @@ "use strict";
 const INSERT_1 = __importStar(require("./INSERT"));
+/**
+ * Adds one or more items to a Cuckoo Filter only if they do not exist yet, creating the filter if needed
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter
+ * @param items - One or more items to add to the filter
+ * @param options - Optional parameters for filter creation
+ * @param options.CAPACITY - The number of entries intended to be added to the filter
+ * @param options.NOCREATE - If true, prevents automatic filter creation
+ */
 exports.default = {
@@ -29,0 +38,0 @@ IS_READ_ONLY: INSERT_1.default.IS_READ_ONLY,

dist/lib/commands/cuckoo/LOADCHUNK.d.ts

@@ -5,2 +5,9 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Restores a Cuckoo Filter chunk previously saved using SCANDUMP
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter to restore
+     * @param iterator - Iterator value from the SCANDUMP command
+     * @param chunk - Data chunk from the SCANDUMP command
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, iterator: number, chunk: RedisArgument) => void;
@@ -7,0 +14,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/cuckoo/LOADCHUNK.js

@@ -5,2 +5,9 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Restores a Cuckoo Filter chunk previously saved using SCANDUMP
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter to restore
+     * @param iterator - Iterator value from the SCANDUMP command
+     * @param chunk - Data chunk from the SCANDUMP command
+     */
     parseCommand(parser, key, iterator, chunk) {
@@ -7,0 +14,0 @@ parser.push('CF.LOADCHUNK');

dist/lib/commands/cuckoo/RESERVE.d.ts

@@ -10,2 +10,12 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Creates an empty Cuckoo Filter with specified capacity and parameters
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter to create
+     * @param capacity - The number of entries intended to be added to the filter
+     * @param options - Optional parameters to tune the filter
+     * @param options.BUCKETSIZE - Number of items in each bucket
+     * @param options.MAXITERATIONS - Maximum number of iterations before declaring filter full
+     * @param options.EXPANSION - Number of additional buckets per expansion
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, capacity: number, options?: CfReserveOptions) => void;
@@ -12,0 +22,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/cuckoo/RESERVE.js

@@ -5,2 +5,12 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Creates an empty Cuckoo Filter with specified capacity and parameters
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter to create
+     * @param capacity - The number of entries intended to be added to the filter
+     * @param options - Optional parameters to tune the filter
+     * @param options.BUCKETSIZE - Number of items in each bucket
+     * @param options.MAXITERATIONS - Maximum number of iterations before declaring filter full
+     * @param options.EXPANSION - Number of additional buckets per expansion
+     */
     parseCommand(parser, key, capacity, options) {
@@ -7,0 +17,0 @@ parser.push('CF.RESERVE');

dist/lib/commands/cuckoo/SCANDUMP.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Begins an incremental save of a Cuckoo Filter. This is useful for large filters that can't be saved at once
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter to save
+     * @param iterator - Iterator value; Start at 0, and use the iterator from the response for the next chunk
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, iterator: number) => void;
@@ -7,0 +13,0 @@ readonly transformReply: (this: void, reply: [NumberReply<number>, NullReply | BlobStringReply<string>]) => {

dist/lib/commands/cuckoo/SCANDUMP.js

@@ -5,2 +5,8 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Begins an incremental save of a Cuckoo Filter. This is useful for large filters that can't be saved at once
+     * @param parser - The command parser
+     * @param key - The name of the Cuckoo filter to save
+     * @param iterator - Iterator value; Start at 0, and use the iterator from the response for the next chunk
+     */
     parseCommand(parser, key, iterator) {
@@ -7,0 +13,0 @@ parser.push('CF.SCANDUMP');

dist/lib/commands/t-digest/ADD.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Adds one or more observations to a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param values - Array of numeric values to add to the sketch
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, values: Array<number>) => void;
@@ -7,0 +13,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/t-digest/ADD.js

@@ -5,2 +5,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Adds one or more observations to a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param values - Array of numeric values to add to the sketch
+     */
     parseCommand(parser, key, values) {
@@ -7,0 +13,0 @@ parser.push('TDIGEST.ADD');

dist/lib/commands/t-digest/BYRANK.d.ts

@@ -6,2 +6,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns value estimates for one or more ranks in a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param ranks - Array of ranks to get value estimates for (ascending order)
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, ranks: number[]) => void;
@@ -8,0 +14,0 @@ readonly transformReply: {

dist/lib/commands/t-digest/BYRANK.js

@@ -14,2 +14,8 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns value estimates for one or more ranks in a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param ranks - Array of ranks to get value estimates for (ascending order)
+     */
     parseCommand(...args) {
@@ -16,0 +22,0 @@ args[0].push('TDIGEST.BYRANK');

dist/lib/commands/t-digest/BYREVRANK.d.ts

@@ -0,1 +1,7 @@
+/**
+ * Returns value estimates for one or more ranks in a t-digest sketch, starting from highest rank
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param ranks - Array of ranks to get value estimates for (descending order)
+ */
 declare const _default: {
@@ -2,0 +8,0 @@ readonly IS_READ_ONLY: true;

dist/lib/commands/t-digest/BYREVRANK.js

@@ -27,2 +27,8 @@ "use strict";
 const BYRANK_1 = __importStar(require("./BYRANK"));
+/**
+ * Returns value estimates for one or more ranks in a t-digest sketch, starting from highest rank
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param ranks - Array of ranks to get value estimates for (descending order)
+ */
 exports.default = {
@@ -29,0 +35,0 @@ IS_READ_ONLY: BYRANK_1.default.IS_READ_ONLY,

dist/lib/commands/t-digest/CDF.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Estimates the cumulative distribution function for values in a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param values - Array of values to get CDF estimates for
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, values: Array<number>) => void;
@@ -7,0 +13,0 @@ readonly transformReply: {

dist/lib/commands/t-digest/CDF.js

@@ -6,2 +6,8 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Estimates the cumulative distribution function for values in a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param values - Array of values to get CDF estimates for
+     */
     parseCommand(parser, key, values) {
@@ -8,0 +14,0 @@ parser.push('TDIGEST.CDF');

dist/lib/commands/t-digest/CREATE.d.ts

@@ -8,2 +8,9 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Creates a new t-digest sketch for storing distributions
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param options - Optional parameters for sketch creation
+     * @param options.COMPRESSION - Compression parameter that affects performance and accuracy
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, options?: TDigestCreateOptions) => void;
@@ -10,0 +17,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/t-digest/CREATE.js

@@ -5,2 +5,9 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Creates a new t-digest sketch for storing distributions
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param options - Optional parameters for sketch creation
+     * @param options.COMPRESSION - Compression parameter that affects performance and accuracy
+     */
     parseCommand(parser, key, options) {
@@ -7,0 +14,0 @@ parser.push('TDIGEST.CREATE');

dist/lib/commands/t-digest/INFO.d.ts

@@ -43,2 +43,7 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns information about a t-digest sketch including compression, capacity, nodes, weights, observations and memory usage
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch to get information about
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument) => void;
@@ -45,0 +50,0 @@ readonly transformReply: {

dist/lib/commands/t-digest/INFO.js

@@ -6,2 +6,7 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns information about a t-digest sketch including compression, capacity, nodes, weights, observations and memory usage
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch to get information about
+     */
     parseCommand(parser, key) {
@@ -8,0 +13,0 @@ parser.push('TDIGEST.INFO');

dist/lib/commands/t-digest/MAX.d.ts

@@ -5,2 +5,7 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns the maximum value from a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument) => void;
@@ -7,0 +12,0 @@ readonly transformReply: {

dist/lib/commands/t-digest/MAX.js

@@ -6,2 +6,7 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns the maximum value from a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     */
     parseCommand(parser, key) {
@@ -8,0 +13,0 @@ parser.push('TDIGEST.MAX');

dist/lib/commands/t-digest/MERGE.d.ts

@@ -10,2 +10,11 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Merges multiple t-digest sketches into one, with optional compression and override settings
+     * @param parser - The command parser
+     * @param destination - The name of the destination t-digest sketch
+     * @param source - One or more source sketch names to merge from
+     * @param options - Optional parameters for merge operation
+     * @param options.COMPRESSION - New compression value for merged sketch
+     * @param options.OVERRIDE - If true, override destination sketch if it exists
+     */
     readonly parseCommand: (this: void, parser: CommandParser, destination: RedisArgument, source: RedisVariadicArgument, options?: TDigestMergeOptions) => void;
@@ -12,0 +21,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/t-digest/MERGE.js

@@ -5,2 +5,11 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Merges multiple t-digest sketches into one, with optional compression and override settings
+     * @param parser - The command parser
+     * @param destination - The name of the destination t-digest sketch
+     * @param source - One or more source sketch names to merge from
+     * @param options - Optional parameters for merge operation
+     * @param options.COMPRESSION - New compression value for merged sketch
+     * @param options.OVERRIDE - If true, override destination sketch if it exists
+     */
     parseCommand(parser, destination, source, options) {
@@ -7,0 +16,0 @@ parser.push('TDIGEST.MERGE');

dist/lib/commands/t-digest/MIN.d.ts

@@ -5,2 +5,7 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns the minimum value from a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument) => void;
@@ -7,0 +12,0 @@ readonly transformReply: {

dist/lib/commands/t-digest/MIN.js

@@ -6,2 +6,7 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns the minimum value from a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     */
     parseCommand(parser, key) {
@@ -8,0 +13,0 @@ parser.push('TDIGEST.MIN');

dist/lib/commands/t-digest/QUANTILE.d.ts

@@ -5,2 +5,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns value estimates at requested quantiles from a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param quantiles - Array of quantiles (between 0 and 1) to get value estimates for
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, quantiles: Array<number>) => void;
@@ -7,0 +13,0 @@ readonly transformReply: {

dist/lib/commands/t-digest/QUANTILE.js

@@ -6,2 +6,8 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns value estimates at requested quantiles from a t-digest sketch
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param quantiles - Array of quantiles (between 0 and 1) to get value estimates for
+     */
     parseCommand(parser, key, quantiles) {
@@ -8,0 +14,0 @@ parser.push('TDIGEST.QUANTILE');

dist/lib/commands/t-digest/RANK.d.ts

@@ -6,2 +6,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns the rank of one or more values in a t-digest sketch (number of values that are lower than each value)
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param values - Array of values to get ranks for
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, values: number[]) => void;
@@ -8,0 +14,0 @@ readonly transformReply: () => ArrayReply<NumberReply>;

dist/lib/commands/t-digest/RANK.js

@@ -13,2 +13,8 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns the rank of one or more values in a t-digest sketch (number of values that are lower than each value)
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param values - Array of values to get ranks for
+     */
     parseCommand(...args) {
@@ -15,0 +21,0 @@ args[0].push('TDIGEST.RANK');

dist/lib/commands/t-digest/RESET.d.ts

@@ -5,2 +5,7 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Resets a t-digest sketch, clearing all previously added observations
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch to reset
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument) => void;
@@ -7,0 +12,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/t-digest/RESET.js

@@ -5,2 +5,7 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Resets a t-digest sketch, clearing all previously added observations
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch to reset
+     */
     parseCommand(parser, key) {
@@ -7,0 +12,0 @@ parser.push('TDIGEST.RESET');

dist/lib/commands/t-digest/REVRANK.d.ts

@@ -0,1 +1,7 @@
+/**
+ * Returns the reverse rank of one or more values in a t-digest sketch (number of values that are higher than each value)
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param values - Array of values to get reverse ranks for
+ */
 declare const _default: {
@@ -2,0 +8,0 @@ readonly IS_READ_ONLY: true;

dist/lib/commands/t-digest/REVRANK.js

@@ -27,2 +27,8 @@ "use strict";
 const RANK_1 = __importStar(require("./RANK"));
+/**
+ * Returns the reverse rank of one or more values in a t-digest sketch (number of values that are higher than each value)
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param values - Array of values to get reverse ranks for
+ */
 exports.default = {
@@ -29,0 +35,0 @@ IS_READ_ONLY: RANK_1.default.IS_READ_ONLY,

dist/lib/commands/t-digest/TRIMMED_MEAN.d.ts

@@ -5,2 +5,9 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns the mean value from a t-digest sketch after trimming values at specified percentiles
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param lowCutPercentile - Lower percentile cutoff (between 0 and 100)
+     * @param highCutPercentile - Higher percentile cutoff (between 0 and 100)
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, lowCutPercentile: number, highCutPercentile: number) => void;
@@ -7,0 +14,0 @@ readonly transformReply: {

dist/lib/commands/t-digest/TRIMMED_MEAN.js

@@ -6,2 +6,9 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns the mean value from a t-digest sketch after trimming values at specified percentiles
+     * @param parser - The command parser
+     * @param key - The name of the t-digest sketch
+     * @param lowCutPercentile - Lower percentile cutoff (between 0 and 100)
+     * @param highCutPercentile - Higher percentile cutoff (between 0 and 100)
+     */
     parseCommand(parser, key, lowCutPercentile, highCutPercentile) {
@@ -8,0 +15,0 @@ parser.push('TDIGEST.TRIMMED_MEAN');

dist/lib/commands/top-k/ADD.d.ts

@@ -6,2 +6,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Adds one or more items to a Top-K filter and returns items dropped from the top-K list
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     * @param items - One or more items to add to the filter
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) => void;
@@ -8,0 +14,0 @@ readonly transformReply: () => ArrayReply<BlobStringReply>;

dist/lib/commands/top-k/ADD.js

@@ -5,2 +5,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Adds one or more items to a Top-K filter and returns items dropped from the top-K list
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     * @param items - One or more items to add to the filter
+     */
     parseCommand(parser, key, items) {
@@ -7,0 +13,0 @@ parser.push('TOPK.ADD');

dist/lib/commands/top-k/COUNT.d.ts

@@ -6,2 +6,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns the count of occurrences for one or more items in a Top-K filter
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     * @param items - One or more items to get counts for
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) => void;
@@ -8,0 +14,0 @@ readonly transformReply: () => ArrayReply<NumberReply>;

dist/lib/commands/top-k/COUNT.js

@@ -5,2 +5,8 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns the count of occurrences for one or more items in a Top-K filter
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     * @param items - One or more items to get counts for
+     */
     parseCommand(parser, key, items) {
@@ -7,0 +13,0 @@ parser.push('TOPK.COUNT');

dist/lib/commands/top-k/INCRBY.d.ts

@@ -9,2 +9,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Increases the score of one or more items in a Top-K filter by specified increments
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     * @param items - A single item or array of items to increment, each with an item name and increment value
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, items: TopKIncrByItem | Array<TopKIncrByItem>) => void;
@@ -11,0 +17,0 @@ readonly transformReply: () => ArrayReply<SimpleStringReply | NullReply>;

dist/lib/commands/top-k/INCRBY.js

@@ -8,2 +8,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Increases the score of one or more items in a Top-K filter by specified increments
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     * @param items - A single item or array of items to increment, each with an item name and increment value
+     */
     parseCommand(parser, key, items) {
@@ -10,0 +16,0 @@ parser.push('TOPK.INCRBY');

dist/lib/commands/top-k/INFO.d.ts

@@ -23,2 +23,7 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns configuration and statistics of a Top-K filter, including k, width, depth, and decay parameters
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter to get information about
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument) => void;
@@ -25,0 +30,0 @@ readonly transformReply: {

dist/lib/commands/top-k/INFO.js

@@ -7,2 +7,7 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns configuration and statistics of a Top-K filter, including k, width, depth, and decay parameters
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter to get information about
+     */
     parseCommand(parser, key) {
@@ -9,0 +14,0 @@ parser.push('TOPK.INFO');

dist/lib/commands/top-k/LIST_WITHCOUNT.d.ts

@@ -5,2 +5,7 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns all items in a Top-K filter with their respective counts
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument) => void;
@@ -7,0 +12,0 @@ readonly transformReply: (this: void, rawReply: UnwrapReply<ArrayReply<BlobStringReply | NumberReply>>) => {

dist/lib/commands/top-k/LIST_WITHCOUNT.js

@@ -5,2 +5,7 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns all items in a Top-K filter with their respective counts
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     */
     parseCommand(parser, key) {
@@ -7,0 +12,0 @@ parser.push('TOPK.LIST');

dist/lib/commands/top-k/LIST.d.ts

@@ -5,2 +5,7 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: true;
+    /**
+     * Returns all items in a Top-K filter
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument) => void;
@@ -7,0 +12,0 @@ readonly transformReply: () => ArrayReply<BlobStringReply>;

dist/lib/commands/top-k/LIST.js

@@ -5,2 +5,7 @@ "use strict";
     IS_READ_ONLY: true,
+    /**
+     * Returns all items in a Top-K filter
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     */
     parseCommand(parser, key) {
@@ -7,0 +12,0 @@ parser.push('TOPK.LIST');

dist/lib/commands/top-k/QUERY.d.ts

@@ -6,2 +6,8 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly IS_READ_ONLY: false;
+    /**
+     * Checks if one or more items are in the Top-K list
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     * @param items - One or more items to check in the filter
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) => void;
@@ -8,0 +14,0 @@ readonly transformReply: {

dist/lib/commands/top-k/QUERY.js

@@ -6,2 +6,8 @@ "use strict";
     IS_READ_ONLY: false,
+    /**
+     * Checks if one or more items are in the Top-K list
+     * @param parser - The command parser
+     * @param key - The name of the Top-K filter
+     * @param items - One or more items to check in the filter
+     */
     parseCommand(parser, key, items) {
@@ -8,0 +14,0 @@ parser.push('TOPK.QUERY');

dist/lib/commands/top-k/RESERVE.d.ts

@@ -10,2 +10,12 @@ import { CommandParser } from '@redis/client/dist/lib/client/parser';
     readonly 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
+     */
     readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, topK: number, options?: TopKReserveOptions) => void;
@@ -12,0 +22,0 @@ readonly transformReply: () => SimpleStringReply<'OK'>;

dist/lib/commands/top-k/RESERVE.js

@@ -5,2 +5,12 @@ "use strict";
     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, key, topK, options) {
@@ -7,0 +17,0 @@ parser.push('TOPK.RESERVE');

package.json

 {
   "name": "@redis/bloom",
-  "version": "5.5.5",
+  "version": "5.5.6",
   "license": "MIT",
@@ -16,3 +16,3 @@ "main": "./dist/lib/index.js",
   "peerDependencies": {
-    "@redis/client": "^5.5.5"
+    "@redis/client": "^5.5.6"
   },
@@ -19,0 +19,0 @@ "devDependencies": {

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

274668

12.47%

Lines of code

3738

20.35%

No dependency changes