You've already forked node-redis
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:
@@ -3,6 +3,14 @@ import { RedisArgument, ArrayReply, NumberReply, NullReply, Command, } from '@re
|
||||
|
||||
export default {
|
||||
IS_READ_ONLY: false,
|
||||
/**
|
||||
* Toggles a boolean value stored in a JSON document.
|
||||
* Returns 1 if value was toggled to true, 0 if toggled to false, or null if path doesn't exist.
|
||||
*
|
||||
* @param parser - The Redis command parser
|
||||
* @param key - The key containing the JSON document
|
||||
* @param path - Path to the boolean value
|
||||
*/
|
||||
parseCommand(parser: CommandParser, key: RedisArgument, path: RedisArgument) {
|
||||
parser.push('JSON.TOGGLE');
|
||||
parser.pushKey(key);
|
||||
|
Reference in New Issue
Block a user