(docs) jsdoc comments to time series commands

Author: bobymicroby

packages/time-series/lib/commands/ADD.ts

@@ -29,6 +29,14 @@ export interface TsAddOptions {
 
 export default {
   IS_READ_ONLY: false,
+  /**
+   * Creates or appends a sample to a time series
+   * @param parser - The command parser
+   * @param key - The key name for the time series
+   * @param timestamp - The timestamp of the sample
+   * @param value - The value of the sample
+   * @param options - Optional configuration parameters
+   */
   parseCommand(
     parser: CommandParser,
     key: RedisArgument,

packages/time-series/lib/commands/ALTER.ts

@@ -8,6 +8,12 @@ export type TsAlterOptions = Pick<TsCreateOptions, 'RETENTION' | 'CHUNK_SIZE' |
 
 export default {
   IS_READ_ONLY: false,
+  /**
+   * Alters the configuration of an existing time series
+   * @param parser - The command parser
+   * @param key - The key name for the time series
+   * @param options - Configuration parameters to alter
+   */
   parseCommand(parser: CommandParser, key: RedisArgument, options?: TsAlterOptions) {
     parser.push('TS.ALTER');
     parser.pushKey(key);

packages/time-series/lib/commands/CREATE.ts

@@ -24,6 +24,12 @@ export interface TsCreateOptions {
 
 export default {
   IS_READ_ONLY: false,
+  /**
+   * Creates a new time series
+   * @param parser - The command parser
+   * @param key - The key name for the new time series
+   * @param options - Optional configuration parameters
+   */
   parseCommand(parser: CommandParser, key: RedisArgument, options?: TsCreateOptions) {
     parser.push('TS.CREATE');
     parser.pushKey(key);

packages/time-series/lib/commands/CREATERULE.ts

@@ -21,6 +21,15 @@ export type TimeSeriesAggregationType = typeof TIME_SERIES_AGGREGATION_TYPE[keyo
 
 export default {
   IS_READ_ONLY: false,
+  /**
+   * Creates a compaction rule from source time series to destination time series
+   * @param parser - The command parser
+   * @param sourceKey - The source time series key
+   * @param destinationKey - The destination time series key
+   * @param aggregationType - The aggregation type to use
+   * @param bucketDuration - The duration of each bucket in milliseconds
+   * @param alignTimestamp - Optional timestamp for alignment
+   */
   parseCommand(
     parser: CommandParser,
     sourceKey: RedisArgument,

packages/time-series/lib/commands/DECRBY.ts

@@ -3,6 +3,10 @@ import INCRBY, { parseIncrByArguments } from './INCRBY';
 
 export default {
   IS_READ_ONLY: INCRBY.IS_READ_ONLY,
+  /**
+   * Decreases the value of a time series by a given amount
+   * @param args - Arguments passed to the parseIncrByArguments function
+   */
   parseCommand(...args: Parameters<typeof parseIncrByArguments>) {
     const parser = args[0];
 

packages/time-series/lib/commands/DEL.ts

@@ -4,6 +4,13 @@ import { RedisArgument, NumberReply, Command, } from '@redis/client/dist/lib/RES
 
 export default {
   IS_READ_ONLY: false,
+  /**
+   * Deletes samples between two timestamps from a time series
+   * @param parser - The command parser
+   * @param key - The key name of the time series
+   * @param fromTimestamp - Start timestamp to delete from
+   * @param toTimestamp - End timestamp to delete until
+   */
   parseCommand(parser: CommandParser, key: RedisArgument, fromTimestamp: Timestamp, toTimestamp: Timestamp) {
     parser.push('TS.DEL');
     parser.pushKey(key);

packages/time-series/lib/commands/DELETERULE.ts

@@ -3,6 +3,12 @@ import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/li
 
 export default {
   IS_READ_ONLY: false,
+  /**
+   * Deletes a compaction rule between source and destination time series
+   * @param parser - The command parser
+   * @param sourceKey - The source time series key
+   * @param destinationKey - The destination time series key
+   */
   parseCommand(parser: CommandParser, sourceKey: RedisArgument, destinationKey: RedisArgument) {
     parser.push('TS.DELETERULE');
     parser.pushKeys([sourceKey, destinationKey]);

packages/time-series/lib/commands/GET.ts

@@ -9,6 +9,12 @@ export type TsGetReply = TuplesReply<[]> | TuplesReply<[NumberReply, DoubleReply
 
 export default {
   IS_READ_ONLY: true,
+  /**
+   * Gets the last sample of a time series
+   * @param parser - The command parser
+   * @param key - The key name of the time series
+   * @param options - Optional parameters for the command
+   */
   parseCommand(parser: CommandParser, key: RedisArgument, options?: TsGetOptions) {
     parser.push('TS.GET');
     parser.pushKey(key);

packages/time-series/lib/commands/INCRBY.ts

@@ -12,6 +12,13 @@ export interface TsIncrByOptions {
   IGNORE?: TsIgnoreOptions;
 }
 
+/**
+ * Parses arguments for incrementing a time series value
+ * @param parser - The command parser
+ * @param key - The key name of the time series
+ * @param value - The value to increment by
+ * @param options - Optional parameters for the command
+ */
 export function parseIncrByArguments(
   parser: CommandParser,
   key: RedisArgument,
@@ -40,6 +47,10 @@ export function parseIncrByArguments(
 
 export default {
   IS_READ_ONLY: false,
+  /**
+   * Increases the value of a time series by a given amount
+   * @param args - Arguments passed to the {@link parseIncrByArguments} function
+   */
   parseCommand(...args: Parameters<typeof parseIncrByArguments>) {
     const parser = args[0];
 

packages/time-series/lib/commands/INFO.ts

@@ -73,6 +73,11 @@ export interface InfoReply {
 
 export default {
     IS_READ_ONLY: true,
+    /**
+     * Gets information about a time series
+     * @param parser - The command parser
+     * @param key - The key name of the time series
+     */
     parseCommand(parser: CommandParser, key: string) {
       parser.push('TS.INFO');
       parser.pushKey(key);