1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-04 15:02:09 +03:00

(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
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

View File

@@ -5,6 +5,16 @@ import LPOS, { LPosOptions } from './LPOS';
export default {
CACHEABLE: LPOS.CACHEABLE,
IS_READ_ONLY: LPOS.IS_READ_ONLY,
/**
* Constructs the LPOS command with COUNT option
*
* @param parser - The command parser
* @param key - The key of the list
* @param element - The element to search for
* @param count - The number of positions to return
* @param options - Optional parameters for RANK and MAXLEN
* @see https://redis.io/commands/lpos/
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,