1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
node-redis/packages/client/lib/commands/MEMORY_USAGE.ts
Bobby I. 20c16e0c2c (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
2025-06-03 14:38:07 +03:00

28 lines
841 B
TypeScript

import { CommandParser } from '../client/parser';
import { NumberReply, NullReply, Command, RedisArgument } from '../RESP/types';
export interface MemoryUsageOptions {
SAMPLES?: number;
}
export default {
IS_READ_ONLY: true,
/**
* Constructs the MEMORY USAGE command
*
* @param parser - The command parser
* @param key - The key to get memory usage for
* @param options - Optional parameters including SAMPLES
* @see https://redis.io/commands/memory-usage/
*/
parseCommand(parser: CommandParser, key: RedisArgument, options?: MemoryUsageOptions) {
parser.push('MEMORY', 'USAGE');
parser.pushKey(key);
if (options?.SAMPLES) {
parser.push('SAMPLES', options.SAMPLES.toString());
}
},
transformReply: undefined as unknown as () => NumberReply | NullReply
} as const satisfies Command;