(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

Author: bobymicroby

packages/bloom/lib/commands/bloom/ADD.ts

@@ -4,6 +4,12 @@ import { transformBooleanReply } from '@redis/client/dist/lib/commands/generic-t
 
 export default {
   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: CommandParser, key: RedisArgument, item: RedisArgument) {
     parser.push('BF.ADD');
     parser.pushKey(key);

packages/bloom/lib/commands/bloom/CARD.ts

@@ -3,6 +3,11 @@ import { RedisArgument, NumberReply, Command } from '@redis/client/dist/lib/RESP
 
 export default {
   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: CommandParser, key: RedisArgument) {
     parser.push('BF.CARD');
     parser.pushKey(key);

packages/bloom/lib/commands/bloom/EXISTS.ts

@@ -4,6 +4,12 @@ import { transformBooleanReply } from '@redis/client/dist/lib/commands/generic-t
 
 export default {
   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: CommandParser, key: RedisArgument, item: RedisArgument) {
     parser.push('BF.EXISTS');
     parser.pushKey(key);

packages/bloom/lib/commands/bloom/INFO.ts

@@ -12,6 +12,11 @@ export type BfInfoReplyMap = TuplesToMapReply<[
 
 export default {
   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: CommandParser, key: RedisArgument) {
     parser.push('BF.INFO');
     parser.pushKey(key);

packages/bloom/lib/commands/bloom/INSERT.ts

@@ -13,6 +13,18 @@ export interface BfInsertOptions {
 
 export default {
   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: CommandParser,
     key: RedisArgument,

packages/bloom/lib/commands/bloom/LOADCHUNK.ts

@@ -3,6 +3,13 @@ import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/li
 
 export default {
   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: CommandParser, key: RedisArgument, iterator: number, chunk: RedisArgument) {
     parser.push('BF.LOADCHUNK');
     parser.pushKey(key);

packages/bloom/lib/commands/bloom/MADD.ts

@@ -5,6 +5,12 @@ import { transformBooleanArrayReply } from '@redis/client/dist/lib/commands/gene
 
 export default {
   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: CommandParser, key: RedisArgument, items: RedisVariadicArgument) {
     parser.push('BF.MADD');
     parser.pushKey(key);

packages/bloom/lib/commands/bloom/MEXISTS.ts

@@ -5,6 +5,12 @@ import { transformBooleanArrayReply } from '@redis/client/dist/lib/commands/gene
 
 export default {
   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: CommandParser, key: RedisArgument, items: RedisVariadicArgument) {
     parser.push('BF.MEXISTS');
     parser.pushKey(key);

packages/bloom/lib/commands/bloom/RESERVE.ts

@@ -8,6 +8,16 @@ export interface BfReserveOptions {
 
 export default {
   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: CommandParser,
     key: RedisArgument,

packages/bloom/lib/commands/bloom/SCANDUMP.ts

@@ -3,6 +3,12 @@ import { RedisArgument, TuplesReply, NumberReply, BlobStringReply, UnwrapReply,
 
 export default {
   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: CommandParser, key: RedisArgument, iterator: number) {
     parser.push('BF.SCANDUMP');
     parser.pushKey(key);