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

12
packages/json/lib/commands/ARRINDEX.ts
View File

@@ -11,6 +11,18 @@ export interface JsonArrIndexOptions {
export default {
IS_READ_ONLY: true,
/**
* Returns the index of the first occurrence of a value in a JSON array.
* If the specified value is not found, it returns -1, or null if the path does not exist.
*
* @param parser - The Redis command parser
* @param key - The key containing the array
* @param path - Path to the array in the JSON document
* @param json - The value to search for
* @param options - Optional range parameters for the search
* @param options.range.start - Starting index for the search
* @param options.range.stop - Optional ending index for the search
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,