redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +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

11
packages/time-series/lib/commands/INCRBY.ts
View File

@@ -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];