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

@@ -16,6 +16,19 @@ export interface JsonSetOptions {
export default {
IS_READ_ONLY: false,
/**
* Sets a JSON value at a specific path in a JSON document.
* Returns OK on success, or null if condition (NX/XX) is not met.
*
* @param parser - The Redis command parser
* @param key - The key containing the JSON document
* @param path - Path in the document to set
* @param json - JSON value to set at the path
* @param options - Optional parameters
* @param options.condition - Set condition: NX (only if doesn't exist) or XX (only if exists)
* @deprecated options.NX - Use options.condition instead
* @deprecated options.XX - Use options.condition instead
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,