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

10
packages/json/lib/commands/ARRPOP.ts
View File

@@ -10,6 +10,16 @@ export interface RedisArrPopOptions {
export default {
IS_READ_ONLY: false,
/**
* Removes and returns an element from an array in a JSON document.
* Returns null if the path does not exist or the value is not an array.
*
* @param parser - The Redis command parser
* @param key - The key containing the array
* @param options - Optional parameters
* @param options.path - Path to the array in the JSON document
* @param options.index - Optional index to pop from. Default is -1 (last element)
*/
parseCommand(parser: CommandParser, key: RedisArgument, options?: RedisArrPopOptions) {
parser.push('JSON.ARRPOP');
parser.pushKey(key);