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:
@@ -7,6 +7,15 @@ export interface JsonStrLenOptions {
|
||||
|
||||
export default {
|
||||
IS_READ_ONLY: true,
|
||||
/**
|
||||
* Returns the length of a string value stored in a JSON document.
|
||||
* Returns string length, array of lengths for multiple paths, or null if path doesn't exist.
|
||||
*
|
||||
* @param parser - The Redis command parser
|
||||
* @param key - The key containing the JSON document
|
||||
* @param options - Optional parameters
|
||||
* @param options.path - Path to the string value
|
||||
*/
|
||||
parseCommand(parser: CommandParser, key: RedisArgument, options?: JsonStrLenOptions) {
|
||||
parser.push('JSON.STRLEN');
|
||||
parser.pushKey(key);
|
||||
|
Reference in New Issue
Block a user