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

9
packages/json/lib/commands/DEBUG_MEMORY.ts
View File

@@ -7,6 +7,15 @@ export interface JsonDebugMemoryOptions {
export default {
IS_READ_ONLY: false,
/**
* Reports memory usage details for a JSON document value.
* Returns size in bytes of the value, or null if the key or path does not 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 value to examine
*/
parseCommand(parser: CommandParser, key: RedisArgument, options?: JsonDebugMemoryOptions) {
parser.push('JSON.DEBUG', 'MEMORY');
parser.pushKey(key);